diff --git a/CHANGELOG/CHANGELOG-r3.md b/CHANGELOG/CHANGELOG-r3.md new file mode 100644 index 0000000..f9e694b --- /dev/null +++ b/CHANGELOG/CHANGELOG-r3.md @@ -0,0 +1,90 @@ +# Changelog SimpleEdgeDiscovery + + +## Table of Contents +- [r3.1](#r31) + + +**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 + +# r3.1 + +## Release Notes + +This release candidate contains the definition and documentation of +* simple-edge-discovery 2.1.0-rc.2 + +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 +* Release Automation: Post-release sync (r2.3) by @camara-release-automation[bot] in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/157 +* [bulk] Update release-automation + validation callers by @camara-release-automation[bot] in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/162 +* docs: sync r2.3 CHANGELOG entry into main by @hdamker in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/163 +* Update CODEOWNERS by @JoseMConde in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/166 +* Update MAINTAINERS.MD by @JoseMConde in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/165 +* [bulk] Update release-automation + validation callers by @camara-release-automation[bot] in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/167 +* chore: update release plan for Sync26 by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/161 +* Sync common files from Commonalities r4.3 by @camara-release-automation[bot] in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/168 +* fix: add explicit type: object to DeviceResponseBody (S-016) by @hdamker in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/154 +* chore: deleted redundant workflow files by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/170 +* chore: deleted redundant API Readiness Checklist by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/173 +* chore: Update meeting schedule from Tuesday to Monday by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/175 +* chore: change $refs to point to common schema by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/177 +* fix: fixed validation warnings for `info.description`, `apiRoot` and string `maxLength` constraints by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/179 +* fix: minor typo in AuthZ/AuthN text in template by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/181 +* fix: align x-correlator references with Commonalities by @hdamker in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/185 + +
+ + +## simple-edge-discovery 2.1.0-rc.2 + +**simple-edge-discovery 2.1.0-rc.2 is a release-candidate version of this API.** + +Changes documented below are compared to version 2.0.1. + +- API definition **with inline documentation**: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimpleEdgeDiscovery/r3.1/code/API_definitions/simple-edge-discovery.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/SimpleEdgeDiscovery/r3.1/code/API_definitions/simple-edge-discovery.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/SimpleEdgeDiscovery/blob/r3.1/code/API_definitions/simple-edge-discovery.yaml) + +### Breaking changes + +* N/A + +### Added + +* N/A + +### Changed + +* N/A + +### Fixed + +* fix: minor typo in AuthZ/AuthN text in template by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/181 + +### Removed + +* N/A + +**Full Changelog**: https://github.com/camaraproject/SimpleEdgeDiscovery/compare/r2.3...r3.1 + diff --git a/README.md b/README.md index 7e73751..3d0c8ba 100644 --- a/README.md +++ b/README.md @@ -29,13 +29,20 @@ Incubating API Repository to evolve and maintain the definitions and documentati > [!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**. -* The latest public release is [r2.3](https://github.com/camaraproject/SimpleEdgeDiscovery/releases/tag/r2.3) (Fall25), with the following API versions: +* The latest public release is [r2.3](https://github.com/camaraproject/SimpleEdgeDiscovery/releases/tag/r2.3), with the following API versions: * **simple-edge-discovery 2.0.1** [[YAML]](https://github.com/camaraproject/SimpleEdgeDiscovery/blob/r2.3/code/API_definitions/simple-edge-discovery.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimpleEdgeDiscovery/r2.3/code/API_definitions/simple-edge-discovery.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/SimpleEdgeDiscovery/r2.3/code/API_definitions/simple-edge-discovery.yaml) * The latest public release is always available here: https://github.com/camaraproject/SimpleEdgeDiscovery/releases/latest * Other releases of this repository are available in https://github.com/camaraproject/SimpleEdgeDiscovery/releases -* For changes see [CHANGELOG](https://github.com/camaraproject/SimpleEdgeDiscovery/blob/main/CHANGELOG.md) +* For changes see [CHANGELOG](https://github.com/camaraproject/SimpleEdgeDiscovery/tree/main/CHANGELOG) + +### Upcoming Release Preview + +* Pre-release: [r3.1](https://github.com/camaraproject/SimpleEdgeDiscovery/releases/tag/r3.1) (release candidate) + * **simple-edge-discovery 2.1.0-rc.2** + [[YAML]](https://github.com/camaraproject/SimpleEdgeDiscovery/blob/r3.1/code/API_definitions/simple-edge-discovery.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimpleEdgeDiscovery/r3.1/code/API_definitions/simple-edge-discovery.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/SimpleEdgeDiscovery/r3.1/code/API_definitions/simple-edge-discovery.yaml) + _The above section is automatically synchronized by CAMARA project-administration._