diff --git a/CHANGELOG/CHANGELOG-r1.md b/CHANGELOG/CHANGELOG-r1.md index be92354..604ca86 100644 --- a/CHANGELOG/CHANGELOG-r1.md +++ b/CHANGELOG/CHANGELOG-r1.md @@ -2,6 +2,7 @@ ## Table of Contents +- [r1.2](#r12) - [r1.1](#r11) @@ -14,6 +15,110 @@ The below sections record the changes for each API version in each release as fo * 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.2 + +## Release Notes + +This release candidate contains the definition and documentation of +* edge-application-management 0.1.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 +* Update API scope and start date in README.md by @Kevsy in https://github.com/camaraproject/EdgeApplicationManagement/pull/3 +* Update MAINTAINERS.MD by @JoseMConde in https://github.com/camaraproject/EdgeApplicationManagement/pull/5 +* Update CODEOWNERS by @JoseMConde in https://github.com/camaraproject/EdgeApplicationManagement/pull/4 +* fix: corrected orgs in MAINTAINERS by @Kevsy in https://github.com/camaraproject/EdgeApplicationManagement/pull/8 +* Add User Story file by @JoseMConde in https://github.com/camaraproject/EdgeApplicationManagement/pull/13 +* Delete documentation/API_documentation/README.MD by @JoseMConde in https://github.com/camaraproject/EdgeApplicationManagement/pull/14 +* Add test files by @JoseMConde in https://github.com/camaraproject/EdgeApplicationManagement/pull/12 +* Adding the definition of the API (YAML) by @JoseMConde in https://github.com/camaraproject/EdgeApplicationManagement/pull/11 +* refactor: Align API definition with commonalities by @DLondonoD in https://github.com/camaraproject/EdgeApplicationManagement/pull/16 +* fix(openapi): schema consistency fixes and comm aligment by @DLondonoD in https://github.com/camaraproject/EdgeApplicationManagement/pull/18 +* Update release-plan.yaml by @JoseMConde in https://github.com/camaraproject/EdgeApplicationManagement/pull/17 +* [bulk] Enable release automation and validation by @camara-release-automation[bot] in https://github.com/camaraproject/EdgeApplicationManagement/pull/20 +* Update release-plan.yaml by @JoseMConde in https://github.com/camaraproject/EdgeApplicationManagement/pull/22 +* Sync common files from Commonalities r4.2 by @camara-release-automation[bot] in https://github.com/camaraproject/EdgeApplicationManagement/pull/24 +* Update MAINTAINERS.MD by @JoseMConde in https://github.com/camaraproject/EdgeApplicationManagement/pull/19 +* [bulk] Update release-automation + validation callers by @camara-release-automation[bot] in https://github.com/camaraproject/EdgeApplicationManagement/pull/26 +* Update release-plan.yaml by @JoseMConde in https://github.com/camaraproject/EdgeApplicationManagement/pull/29 +* fix: minor corrections from automatic validation by @DLondonoD in https://github.com/camaraproject/EdgeApplicationManagement/pull/27 +* fix: add reference to CAMARA_common.yaml schemas by @DLondonoD in https://github.com/camaraproject/EdgeApplicationManagement/pull/28 +* Sync common files from Commonalities r4.3 by @camara-release-automation[bot] in https://github.com/camaraproject/EdgeApplicationManagement/pull/30 +* Fix: Update testing files names by @DLondonoD in https://github.com/camaraproject/EdgeApplicationManagement/pull/31 +* fix: reference to xcorrelator schema by @DLondonoD in https://github.com/camaraproject/EdgeApplicationManagement/pull/33 +* Release Automation: Post-release sync (r1.1) by @camara-release-automation[bot] in https://github.com/camaraproject/EdgeApplicationManagement/pull/36 +* fix: mandatory templates for info.description by @DLondonoD in https://github.com/camaraproject/EdgeApplicationManagement/pull/38 +* Update release-plan.yaml by @JoseMConde in https://github.com/camaraproject/EdgeApplicationManagement/pull/37 +* Update release-plan.yaml by @JoseMConde in https://github.com/camaraproject/EdgeApplicationManagement/pull/41 +* Improve API definitions with common response components and validation patterns by @DLondonoD in https://github.com/camaraproject/EdgeApplicationManagement/pull/44 +* Mark credential fields as writeOnly in EAM schema by @DLondonoD in https://github.com/camaraproject/EdgeApplicationManagement/pull/55 +* Remove "API" from info.title per Design Guide 5.3.1 (#51) by @DLondonoD in https://github.com/camaraproject/EdgeApplicationManagement/pull/60 +* Fix broken regex, callback body shape, and externalDocs link (#50) by @DLondonoD in https://github.com/camaraproject/EdgeApplicationManagement/pull/59 +* Fix HTTP status codes to match Design Guide semantics (#48) by @DLondonoD in https://github.com/camaraproject/EdgeApplicationManagement/pull/56 +* Fix resource modelling inconsistencies across apps/instances/deployments (#49) by @DLondonoD in https://github.com/camaraproject/EdgeApplicationManagement/pull/58 +* Fix wrong operationId sent in several .feature files (#52) by @DLondonoD in https://github.com/camaraproject/EdgeApplicationManagement/pull/61 +* Fix phantom schemas, wrong error codes, and copy-paste bugs in feature files (#53) by @DLondonoD in https://github.com/camaraproject/EdgeApplicationManagement/pull/62 +* Add missing 401 scenarios and updateAppDeployment's 409 scenario (#54) by @DLondonoD in https://github.com/camaraproject/EdgeApplicationManagement/pull/63 +* Fix CAMARA validation warnings from Actions run 30633755325 by @DLondonoD in https://github.com/camaraproject/EdgeApplicationManagement/pull/66 + +## New Contributors +* @Kevsy made their first contribution in https://github.com/camaraproject/EdgeApplicationManagement/pull/3 +* @JoseMConde made their first contribution in https://github.com/camaraproject/EdgeApplicationManagement/pull/5 + +
+ + +## edge-application-management 0.1.0-rc.1 + +**edge-application-management 0.1.0-rc.1 is the first release-candidate version of this API.** + +- API definition **with inline documentation**: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/EdgeApplicationManagement/r1.2/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.2/code/API_definitions/edge-application-management.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/EdgeApplicationManagement/blob/r1.2/code/API_definitions/edge-application-management.yaml) + +### Breaking changes + + * N/A — this is the first release of the API; there is no prior public release to compare against. + + ### Added + + Initial release of the Edge Application Management API, providing lifecycle management for applications, application +instances and application deployments, plus Edge Cloud discovery capabilities. + + * **Application management**: `submitApp`, `getApps`, `getApp`, `deleteApp` + * **Application instance management**: `createAppInstance`, `getAppInstances`, `getAppInstance`, `deleteAppInstance` + * **Application deployment management**: `createAppDeployment`, `getAppDeployments`, `getAppDeployment`, +`updateAppDeployment`, `deleteAppDeployment` + * **Edge Cloud discovery**: `getEdgeCloudZones`, `getClusters` + * **Event notifications**: callback-based subscriptions for application instance and deployment status changes + + ### Changed + + * N/A — this is the first release of the API; there is no prior public release to compare against. + + ### Fixed + + * N/A — this is the first release of the API; there is no prior public release to compare against. + + ### Removed + + * N/A — this is the first release of the API; there is no prior public release to compare against. + +**Full Changelog**: https://github.com/camaraproject/EdgeApplicationManagement/commits/r1.2 + # r1.1 ## Release Notes diff --git a/README.md b/README.md index f843c28..bfa0f66 100644 --- a/README.md +++ b/README.md @@ -30,9 +30,9 @@ Sandbox API Repository to describe, develop, document, and test the EdgeApplicat > [!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) +* The latest pre-release is [r1.2](https://github.com/camaraproject/EdgeApplicationManagement/releases/tag/r1.2) (release candidate), with the following API versions: + * **edge-application-management 0.1.0-rc.1** + [[YAML]](https://github.com/camaraproject/EdgeApplicationManagement/blob/r1.2/code/API_definitions/edge-application-management.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/EdgeApplicationManagement/r1.2/code/API_definitions/edge-application-management.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/EdgeApplicationManagement/r1.2/code/API_definitions/edge-application-management.yaml) * For changes see [CHANGELOG](https://github.com/camaraproject/EdgeApplicationManagement/tree/main/CHANGELOG)