diff --git a/CHANGELOG/CHANGELOG-r1.md b/CHANGELOG/CHANGELOG-r1.md new file mode 100644 index 0000000..d6712e1 --- /dev/null +++ b/CHANGELOG/CHANGELOG-r1.md @@ -0,0 +1,170 @@ +# Changelog ReleaseTest + + +## Table of Contents +- [r1.1](#r11) + + +**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 + +# r1.1 + +## Release Notes + +This pre-release contains the definition and documentation of +* sample-service 0.1.0-alpha.1 +* sample-service-subscriptions 0.1.0-alpha.1 +* sample-implicit-events 0.1.0-alpha.1 + +The API definition(s) are based on +* Commonalities 0.7.0-rc.1 + work in progress towards rc.2 +* Identity and Consent Management 0.5.0-rc.1 + + +> **Working area — candidate changes (auto-removed on merge)** +> Copy relevant entries into the Added/Changed/Fixed/Removed sections below. +> 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] Add release-plan.yaml (2026-02-19-001) by @hdamker-bot in https://github.com/camaraproject/ReleaseTest/pull/3 +* [bulk] Sync release automation configuration (2026-02-19-001) by @hdamker-bot in https://github.com/camaraproject/ReleaseTest/pull/4 +* Update release-plan.yaml by @hdamker-bot in https://github.com/camaraproject/ReleaseTest/pull/5 +* Test file mismatch case by @hdamker-bot in https://github.com/camaraproject/ReleaseTest/pull/9 +* Update release-plan.yaml by @hdamker-bot in https://github.com/camaraproject/ReleaseTest/pull/11 +* Release Automation: Post-release sync (r1.1) by @camara-release-automation[bot] in https://github.com/camaraproject/ReleaseTest/pull/16 +* Update release-plan.yaml by @hdamker-bot in https://github.com/camaraproject/ReleaseTest/pull/17 +* Update release-test.yaml by @hdamker-bot in https://github.com/camaraproject/ReleaseTest/pull/20 +* Release Automation: Post-release sync (r1.1) by @camara-release-automation[bot] in https://github.com/camaraproject/ReleaseTest/pull/22 +* Create release-test-getStatus.feature by @hdamker-bot in https://github.com/camaraproject/ReleaseTest/pull/23 +* Add test definition file release-test-getStatus.feature by @hdamker-bot in https://github.com/camaraproject/ReleaseTest/pull/28 +* Update release-plan.yaml by @hdamker-bot in https://github.com/camaraproject/ReleaseTest/pull/37 +* Release Automation: Post-release sync (r1.2) by @camara-release-automation[bot] in https://github.com/camaraproject/ReleaseTest/pull/40 +* chore(workflow): sync release automation caller template by @hdamker in https://github.com/camaraproject/ReleaseTest/pull/41 +* chore(release-plan): advance ReleaseTest to r1.3 for automation validation by @hdamker in https://github.com/camaraproject/ReleaseTest/pull/42 +* Release Automation: Post-release sync (r1.3) by @camara-release-automation[bot] in https://github.com/camaraproject/ReleaseTest/pull/45 +* Add files via upload by @hdamker-bot in https://github.com/camaraproject/ReleaseTest/pull/48 +* Add global tags definition to test API spec by @hdamker in https://github.com/camaraproject/ReleaseTest/pull/49 +* Update release-automation.yml by @hdamker-bot in https://github.com/camaraproject/ReleaseTest/pull/50 +* Rename workflow and update reusable workflow reference by @hdamker in https://github.com/camaraproject/ReleaseTest/pull/53 +* chore: update workflow references to upstream tooling by @hdamker in https://github.com/camaraproject/ReleaseTest/pull/54 +* fix: restore secrets: inherit for release automation caller by @hdamker in https://github.com/camaraproject/ReleaseTest/pull/59 +* fix: align API definitions with Design Guide and Commonalities artifacts by @hdamker in https://github.com/camaraproject/ReleaseTest/pull/62 +* feat: add sample-service-subscriptions API definition by @hdamker in https://github.com/camaraproject/ReleaseTest/pull/63 +* fix: comment out non-HTTP protocol support (not yet used in CAMARA) by @hdamker in https://github.com/camaraproject/ReleaseTest/pull/64 +* fix: align common files and templates with Commonalities #606 by @hdamker in https://github.com/camaraproject/ReleaseTest/pull/67 +* [bulk] Enable release automation and validation (2026-04-10-001) by @camara-release-automation[bot] in https://github.com/camaraproject/ReleaseTest/pull/69 +* feat: add sample-implicit-events as third sample API by @hdamker in https://github.com/camaraproject/ReleaseTest/pull/71 +* chore: reset release plan to r1.1 (target_release_type: none) by @hdamker in https://github.com/camaraproject/ReleaseTest/pull/72 +* chore: remove release-test API and stale CHANGELOG by @hdamker in https://github.com/camaraproject/ReleaseTest/pull/73 +* chore: activate r1.1 alpha release cycle by @hdamker in https://github.com/camaraproject/ReleaseTest/pull/74 +* fix: sync sample API templates with Commonalities #606 by @hdamker in https://github.com/camaraproject/ReleaseTest/pull/77 + +
+ + +## sample-service 0.1.0-alpha.1 + +**sample-service 0.1.0-alpha.1 is ...** + +- API definition **with inline documentation**: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ReleaseTest/r1.1/code/API_definitions/sample-service.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ReleaseTest/r1.1/code/API_definitions/sample-service.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/ReleaseTest/blob/r1.1/code/API_definitions/sample-service.yaml) + +### Added + +* Initial API definition based on the Commonalities `sample-service.yaml` template (work in progress between r4.1 and r4.2, tracked in [Commonalities#606](https://github.com/camaraproject/Commonalities/pull/606)) +* Resource management endpoints under `/resources`: + * `createResource` — `POST /resources` + * `listResources` — `GET /resources` + * `getResource` — `GET /resources/{resourceId}` + * `deleteResource` — `DELETE /resources/{resourceId}` +* CAMARA-aligned error model and security scheme (`openId` with standard scopes) + +### Changed + +* None — first release + +### Fixed + +* None — first release + +### Removed + +* None — first release + +## sample-service-subscriptions 0.1.0-alpha.1 + +**sample-service-subscriptions 0.1.0-alpha.1 is ...** + +- API definition **with inline documentation**: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ReleaseTest/r1.1/code/API_definitions/sample-service-subscriptions.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ReleaseTest/r1.1/code/API_definitions/sample-service-subscriptions.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/ReleaseTest/blob/r1.1/code/API_definitions/sample-service-subscriptions.yaml) + +### Added + +* Initial API definition based on the Commonalities `sample-service-subscriptions.yaml` (explicit subscription) template (work in progress between r4.1 and r4.2, tracked in [Commonalities#606](https://github.com/camaraproject/Commonalities/pull/606)) +* Event subscription management endpoints under `/subscriptions`: + * `createSampleServiceSubscription` — `POST /subscriptions` + * `retrieveSampleServiceSubscriptionList` — `GET /subscriptions` + * `retrieveSampleServiceSubscription` — `GET /subscriptions/{subscriptionId}` + * `deleteSampleServiceSubscription` — `DELETE /subscriptions/{subscriptionId}` +* CloudEvents-based event delivery using the shared `CAMARA_event_common.yaml` schema + +### Changed + +* None — first release + +### Fixed + +* None — first release + +### Removed + +* None — first release + +## sample-implicit-events 0.1.0-alpha.1 + +**sample-implicit-events 0.1.0-alpha.1 is ...** + +- API definition **with inline documentation**: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ReleaseTest/r1.1/code/API_definitions/sample-implicit-events.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ReleaseTest/r1.1/code/API_definitions/sample-implicit-events.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/ReleaseTest/blob/r1.1/code/API_definitions/sample-implicit-events.yaml) + +### Added + +* Initial API definition based on the Commonalities `sample-implicit-events.yaml` (implicit subscription) template (work in progress between r4.1 and r4.2, drafted in [Commonalities#612](https://github.com/camaraproject/Commonalities/pull/612) as a follow-up to #606 / [Commonalities#608](https://github.com/camaraproject/Commonalities/issues/608)) +* Resource management endpoints under `/resources` with implicit event delivery (no explicit subscription management): + * `createResource` — `POST /resources` + * `listResources` — `GET /resources` + * `getResource` — `GET /resources/{resourceId}` + * `deleteResource` — `DELETE /resources/{resourceId}` +* CloudEvents-based notifications driven by resource lifecycle, using the shared `CAMARA_event_common.yaml` schema + +### Changed + +* None — first release + +### Fixed + +* None — first release + +### Removed + +* None — first release + +**Full Changelog**: https://github.com/camaraproject/ReleaseTest/commits/r1.1 + diff --git a/README.md b/README.md index f3802e1..c8235fd 100644 --- a/README.md +++ b/README.md @@ -28,9 +28,13 @@ Test repository for end-to-end validation of the automated release workflow. Con > [!NOTE] > This repository has only pre-release versions available yet. Pre-releases are for testing and may change before public release. -* The latest pre-release is [r1.3](https://github.com/camaraproject/ReleaseTest/releases/tag/r1.3) (release candidate), with the following API versions: - * **release-test 1.0.0-rc.2** - [[YAML]](https://github.com/camaraproject/ReleaseTest/blob/r1.3/code/API_definitions/release-test.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ReleaseTest/r1.3/code/API_definitions/release-test.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ReleaseTest/r1.3/code/API_definitions/release-test.yaml) +* The latest pre-release is [r1.1](https://github.com/camaraproject/ReleaseTest/releases/tag/r1.1) (alpha), with the following API versions: + * **sample-service 0.1.0-alpha.1** + [[YAML]](https://github.com/camaraproject/ReleaseTest/blob/r1.1/code/API_definitions/sample-service.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ReleaseTest/r1.1/code/API_definitions/sample-service.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ReleaseTest/r1.1/code/API_definitions/sample-service.yaml) + * **sample-service-subscriptions 0.1.0-alpha.1** + [[YAML]](https://github.com/camaraproject/ReleaseTest/blob/r1.1/code/API_definitions/sample-service-subscriptions.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ReleaseTest/r1.1/code/API_definitions/sample-service-subscriptions.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ReleaseTest/r1.1/code/API_definitions/sample-service-subscriptions.yaml) + * **sample-implicit-events 0.1.0-alpha.1** + [[YAML]](https://github.com/camaraproject/ReleaseTest/blob/r1.1/code/API_definitions/sample-implicit-events.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ReleaseTest/r1.1/code/API_definitions/sample-implicit-events.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ReleaseTest/r1.1/code/API_definitions/sample-implicit-events.yaml) * For changes see [CHANGELOG](https://github.com/camaraproject/ReleaseTest/tree/main/CHANGELOG)