diff --git a/CHANGELOG/CHANGELOG-r2.md b/CHANGELOG/CHANGELOG-r2.md new file mode 100644 index 0000000..8a43ec1 --- /dev/null +++ b/CHANGELOG/CHANGELOG-r2.md @@ -0,0 +1,88 @@ +# Changelog ApplicationProfiles + + +## 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 +* application-profiles 0.6.0-rc.1 + +The API definition(s) are based on +* Commonalities r4.3 (0.8.0) +* Identity and Consent Management r4.2 (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 +* resetting version to wip by @maheshc01 in https://github.com/camaraproject/ApplicationProfiles/pull/23 +* [bulk] Sync Release Information section (2025-12-12-001) by @hdamker-bot in https://github.com/camaraproject/ApplicationProfiles/pull/24 +* [bulk] Add release-plan.yaml (2026-02-23-001) by @hdamker-bot in https://github.com/camaraproject/ApplicationProfiles/pull/25 +* [bulk] Enable release automation and validation by @camara-release-automation[bot] in https://github.com/camaraproject/ApplicationProfiles/pull/26 +* prepare application profiles release plan for rc by @maheshc01 in https://github.com/camaraproject/ApplicationProfiles/pull/29 +* Sync common files from Commonalities r4.3 by @camara-release-automation[bot] in https://github.com/camaraproject/ApplicationProfiles/pull/30 +* fix: correct DELETE response code to 204 in test feature file by @maheshc01 in https://github.com/camaraproject/ApplicationProfiles/pull/35 +* fix: align API with CAMARA Commonalities r4.3 validation requirements by @maheshc01 in https://github.com/camaraproject/ApplicationProfiles/pull/33 +* fix: added missing x-correlator headers to 200 / 204 responses by @Kevsy in https://github.com/camaraproject/ApplicationProfiles/pull/38 + +## New Contributors +* @camara-release-automation[bot] made their first contribution in https://github.com/camaraproject/ApplicationProfiles/pull/26 + +
+ + +## application-profiles 0.6.0-rc.1 + +**application-profiles 0.6.0-rc.1 is a release-candidate version of this API.** + +Changes documented below are compared to version 0.5.0. + +- API definition **with inline documentation**: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ApplicationProfiles/r2.1/code/API_definitions/application-profiles.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ApplicationProfiles/r2.1/code/API_definitions/application-profiles.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/ApplicationProfiles/blob/r2.1/code/API_definitions/application-profiles.yaml) + +### Breaking changes + +* N/A + +### Added + +* N/A + +### Changed + +* N/A + +### Fixed + +* fix: correct DELETE response code to 204 in test feature file by @maheshc01 in https://github.com/camaraproject/ApplicationProfiles/pull/35 +* fix: align API with CAMARA Commonalities r4.3 validation requirements by @maheshc01 in https://github.com/camaraproject/ApplicationProfiles/pull/33 +* fix: added missing x-correlator headers to 200 / 204 responses by @Kevsy in https://github.com/camaraproject/ApplicationProfiles/pull/38 + +### Removed + +* N/A + +**Full Changelog**: https://github.com/camaraproject/ApplicationProfiles/compare/r1.2...r2.1 + diff --git a/README.md b/README.md index 30f7c46..0d9c8b5 100644 --- a/README.md +++ b/README.md @@ -30,14 +30,20 @@ Sandbox API Repository to describe, develop, document, and test the ApplicationP > [!NOTE] > 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 a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**. -* **NEW**: The latest public release is [r1.2](https://github.com/camaraproject/ApplicationProfiles/releases/tag/r1.2) (Fall25), with the following API versions: - * **application-profiles v0.5.0** - [[YAML]](https://github.com/camaraproject/ApplicationProfiles/blob/r1.2/code/API_definitions/application-profiles.yaml) - [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ApplicationProfiles/r1.2/code/API_definitions/application-profiles.yaml&nocors) - [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ApplicationProfiles/r1.2/code/API_definitions/application-profiles.yaml) +* The latest public release is [r1.2](https://github.com/camaraproject/ApplicationProfiles/releases/tag/r1.2), with the following API versions: + * **application-profiles 0.5.0** + [[YAML]](https://github.com/camaraproject/ApplicationProfiles/blob/r1.2/code/API_definitions/application-profiles.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ApplicationProfiles/r1.2/code/API_definitions/application-profiles.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ApplicationProfiles/r1.2/code/API_definitions/application-profiles.yaml) + * The latest public release is always available here: https://github.com/camaraproject/ApplicationProfiles/releases/latest * Other releases of this repository are available in https://github.com/camaraproject/ApplicationProfiles/releases -* For changes see [CHANGELOG.md](https://github.com/camaraproject/ApplicationProfiles/blob/main/CHANGELOG.md) +* For changes see [CHANGELOG](https://github.com/camaraproject/ApplicationProfiles/tree/main/CHANGELOG) + +### Upcoming Release Preview + +* Pre-release: [r2.1](https://github.com/camaraproject/ApplicationProfiles/releases/tag/r2.1) (release candidate) + * **application-profiles 0.6.0-rc.1** + [[YAML]](https://github.com/camaraproject/ApplicationProfiles/blob/r2.1/code/API_definitions/application-profiles.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ApplicationProfiles/r2.1/code/API_definitions/application-profiles.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ApplicationProfiles/r2.1/code/API_definitions/application-profiles.yaml) + _The above section is automatically synchronized by CAMARA project-administration._