diff --git a/CHANGELOG/CHANGELOG-r2.md b/CHANGELOG/CHANGELOG-r2.md new file mode 100644 index 0000000..4dd9bd0 --- /dev/null +++ b/CHANGELOG/CHANGELOG-r2.md @@ -0,0 +1,92 @@ +# Changelog SubscriptionStatus + + +## Table of Contents +- [r2.1](#r21) + + +**Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until it has been released. For example, changes may be reverted before a release is published. For the best results, use the latest published release.** + +The below sections record the changes for each API version in each release as follows: + +* for an alpha release, the delta with respect to the previous release +* for the first release-candidate, all changes since the last public release +* for subsequent release-candidate(s), only the delta to the previous release-candidate +* for a public release, the consolidated changes since the previous public release + +# r2.1 + +## Release Notes + +This release candidate contains the definition and documentation of +* subscription-status 0.2.0-rc.1 + +The API definition(s) are based on +* Commonalities 0.8.0 +* Identity and Consent Management 0.5.0 + + +> **Working area — candidate changes (auto-removed on merge)** +> Copy relevant entries into the Breaking changes/Added/Changed/Fixed/Removed sections below. List breaking changes both in Breaking changes and in their normal change category. +> You may edit this list while triaging; it will be removed on merge. +> This working-area section is removed automatically when the PR is merged. + +
+Candidate changes (auto-generated from merged PRs) + +## What's Changed +* [bulk] Sync Release Information section (2025-12-12-001) by @hdamker-bot in https://github.com/camaraproject/SubscriptionStatus/pull/22 +* [bulk] Add release-plan.yaml (2026-02-23-001) by @hdamker-bot in https://github.com/camaraproject/SubscriptionStatus/pull/23 +* Modify meeting time by @chinaunicomyangfan in https://github.com/camaraproject/SubscriptionStatus/pull/24 +* fix: reset API version to wip on main (fixes #21) by @hdamker in https://github.com/camaraproject/SubscriptionStatus/pull/26 +* [bulk] Enable release automation and validation by @camara-release-automation[bot] in https://github.com/camaraproject/SubscriptionStatus/pull/27 +* prepare subscription status release plan for rc by @ToshiWakayama-KDDI in https://github.com/camaraproject/SubscriptionStatus/pull/30 +* release-plan.yaml correction for rc: target_release_tag from r2.0 to r2.1 by @ToshiWakayama-KDDI in https://github.com/camaraproject/SubscriptionStatus/pull/33 +* Sync common files from Commonalities r4.3 by @camara-release-automation[bot] in https://github.com/camaraproject/SubscriptionStatus/pull/31 +* Align subscription-status with Sync26 RC requirements by @chinaunicomyangfan in https://github.com/camaraproject/SubscriptionStatus/pull/36 + +## New Contributors +* @camara-release-automation[bot] made their first contribution in https://github.com/camaraproject/SubscriptionStatus/pull/27 +* @ToshiWakayama-KDDI made their first contribution in https://github.com/camaraproject/SubscriptionStatus/pull/30 + +
+ + +## subscription-status 0.2.0-rc.1 + +**subscription-status 0.2.0-rc.1 is a release-candidate version of this API.** + +Changes documented below are compared to version 0.1.0. + +- API definition **with inline documentation**: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SubscriptionStatus/r2.1/code/API_definitions/subscription-status.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/SubscriptionStatus/r2.1/code/API_definitions/subscription-status.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/SubscriptionStatus/blob/r2.1/code/API_definitions/subscription-status.yaml) + +### Breaking changes + +* Renamed the endpoint path from `/retrive-subscription-status` to `/retrieve-subscription-status`, including the corresponding OAuth2 scope `subscription-status:retrieve-subscription-status`, tag and `operationId` (typo fix with impact on API consumers) by @chinaunicomyangfan in https://github.com/camaraproject/SubscriptionStatus/pull/36 +* Aligned the phone number identification behaviour with the CAMARA guidelines: when a three-legged access token is used, the optional `phoneNumber` MUST NOT be provided in the request body; if it is provided anyway, the server now responds with `422 UNNECESSARY_IDENTIFIER` instead of `403 INVALID_TOKEN_CONTEXT` by @chinaunicomyangfan in https://github.com/camaraproject/SubscriptionStatus/pull/36 + +### Added + +* Added a test scenario for the `422 UNNECESSARY_IDENTIFIER` error when a phone number is unnecessarily provided with a three-legged access token by @chinaunicomyangfan in https://github.com/camaraproject/SubscriptionStatus/pull/36 + +### Changed + +* Renamed the endpoint path from `/retrive-subscription-status` to `/retrieve-subscription-status`, including the corresponding OAuth2 scope, tag and `operationId` by @chinaunicomyangfan in https://github.com/camaraproject/SubscriptionStatus/pull/36 +* Aligned the phone number identification behaviour with the CAMARA guidelines: when a three-legged access token is used, the optional `phoneNumber` MUST NOT be provided in the request body; if it is provided anyway, the server now responds with `422 UNNECESSARY_IDENTIFIER` by @chinaunicomyangfan in https://github.com/camaraproject/SubscriptionStatus/pull/36 +* Aligned the API definition with Commonalities r4.3 and ICM r4.2 requirements for the Sync26 meta-release: `x-camara-commonalities` updated to `0.8.0`, common schemas (`PhoneNumber`, `ErrorInfo`, `x-correlator`, `securitySchemes`) now referenced from `CAMARA_common.yaml`, mandatory documentation sections marked with `CAMARA:MANDATORY` markers by @chinaunicomyangfan in https://github.com/camaraproject/SubscriptionStatus/pull/36 +* Request bodies with undeclared properties are now rejected with `400 INVALID_ARGUMENT` (`additionalProperties: false` on request and response schemas) by @chinaunicomyangfan in https://github.com/camaraproject/SubscriptionStatus/pull/36 +* Updated the error catalogue: removed the `403 INVALID_TOKEN_CONTEXT` error response and updated the `422 UNNECESSARY_IDENTIFIER` example description by @chinaunicomyangfan in https://github.com/camaraproject/SubscriptionStatus/pull/36 + +### Fixed + +* Fixed the typo in the endpoint path, OAuth2 scope, tag and `operationId` (`retrive` -> `retrieve`) by @chinaunicomyangfan in https://github.com/camaraproject/SubscriptionStatus/pull/36 + +### Removed + +* Removed the `403 INVALID_TOKEN_CONTEXT` error response from the API definition, following the alignment with the CAMARA phone number identification guidelines by @chinaunicomyangfan in https://github.com/camaraproject/SubscriptionStatus/pull/36 + +**Full Changelog**: https://github.com/camaraproject/SubscriptionStatus/compare/r1.2...r2.1 +