diff --git a/CHANGELOG/CHANGELOG-r1.md b/CHANGELOG/CHANGELOG-r1.md new file mode 100644 index 0000000..be92354 --- /dev/null +++ b/CHANGELOG/CHANGELOG-r1.md @@ -0,0 +1,62 @@ +# Changelog EdgeApplicationManagement + + +## 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 +* edge-application-management 0.1.0-alpha.1 + +The API definition(s) are based on +* Commonalities 0.8.0 +* Identity and Consent Management 0.5.0 + +## edge-application-management 0.1.0-alpha.1 + +**edge-application-management 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/EdgeApplicationManagement/r1.1/code/API_definitions/edge-application-management.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/EdgeApplicationManagement/r1.1/code/API_definitions/edge-application-management.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/EdgeApplicationManagement/blob/r1.1/code/API_definitions/edge-application-management.yaml) + +### Added + +Initial release of the Edge Application Management API. + +This version introduces the complete set of endpoints, data models, and operations required to manage edge applications, including lifecycle management and related capabilities. + +### Changed + +Not applicable. + +This is the first release of the API; therefore, no changes from previous versions exist. + +### Fixed + +Not applicable. + +No prior versions exist; therefore, no fixes are included in this release. + +### Removed + +Not applicable. + +No features have been removed as this is the initial version of the API. + +**Full Changelog**: https://github.com/camaraproject/EdgeApplicationManagement/commits/r1.1 + diff --git a/README.md b/README.md index 826613c..f843c28 100644 --- a/README.md +++ b/README.md @@ -27,8 +27,16 @@ Sandbox API Repository to describe, develop, document, and test the EdgeApplicat ## Release Information -The repository has no (pre)releases yet, work in progress is within the main branch. +> [!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.1](https://github.com/camaraproject/EdgeApplicationManagement/releases/tag/r1.1) (alpha), with the following API versions: + * **edge-application-management 0.1.0-alpha.1** + [[YAML]](https://github.com/camaraproject/EdgeApplicationManagement/blob/r1.1/code/API_definitions/edge-application-management.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/EdgeApplicationManagement/r1.1/code/API_definitions/edge-application-management.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/EdgeApplicationManagement/r1.1/code/API_definitions/edge-application-management.yaml) + +* For changes see [CHANGELOG](https://github.com/camaraproject/EdgeApplicationManagement/tree/main/CHANGELOG) + +_The above section is automatically synchronized by CAMARA project-administration._ ## Contributing