From 60cd86baf97f948a8203f51108e9c70bd3eb1f52 Mon Sep 17 00:00:00 2001 From: urvika-v Date: Thu, 28 Aug 2025 00:45:00 +0530 Subject: [PATCH 1/9] Updated version to 0.1.0 in optimal-edge-discovery.yaml --- code/API_definitions/optimal-edge-discovery.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/code/API_definitions/optimal-edge-discovery.yaml b/code/API_definitions/optimal-edge-discovery.yaml index 3a97850..debbc61 100644 --- a/code/API_definitions/optimal-edge-discovery.yaml +++ b/code/API_definitions/optimal-edge-discovery.yaml @@ -5,7 +5,7 @@ openapi: 3.0.3 ############################################################################ info: title: Optimal Edge Discovery - version: wip + version: 0.1.0 x-camara-commonalities: 0.6 description: | # Introduction @@ -219,7 +219,7 @@ externalDocs: # Servers # ############################################################################ servers: - - url: "{apiRoot}/optimal-edge-discovery/vwip" + - url: "{apiRoot}/optimal-edge-discovery/v0.1" variables: apiRoot: default: https://localhost:9091 From bee708040c933dd4cac71e5507ce4d2c6fa572bc Mon Sep 17 00:00:00 2001 From: urvika-v Date: Thu, 28 Aug 2025 00:46:32 +0530 Subject: [PATCH 2/9] Update version to 0.1.0 in optimal-edge-discovery.feature --- code/Test_definitions/optimal-edge-discovery.feature | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/code/Test_definitions/optimal-edge-discovery.feature b/code/Test_definitions/optimal-edge-discovery.feature index a662a80..e7016ba 100644 --- a/code/Test_definitions/optimal-edge-discovery.feature +++ b/code/Test_definitions/optimal-edge-discovery.feature @@ -1,11 +1,11 @@ @Optimal_Edge_Discovery -Feature: CAMARA Optimal Edge Discovery API, vwip - Operations for discovering optimal edge cloud zones +Feature: CAMARA Optimal Edge Discovery API, v0.1.0 - Operations for discovering optimal edge cloud zones # Input to be provided by the implementation to the tests # References to OAS spec schemas refer to schemas specified in optimal-edge-discovery.yaml Background: Common Optimal Edge Discovery setup - Given the resource "{apiroot}/optimal-edge-discovery/vwip" as base-url + Given the resource "{apiroot}/optimal-edge-discovery/v0.1" as base-url And the header "Content-Type" is set to "application/json" And the header "Authorization" is set to a valid access token And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator" From e14d3b8b3a65cc5799b73ba38fd8ba24ab6cb73e Mon Sep 17 00:00:00 2001 From: urvika-v Date: Thu, 28 Aug 2025 00:50:38 +0530 Subject: [PATCH 3/9] Update versions of ICM/Com in optimal-edge-discovery-API-Readiness-Checklist.md --- .../optimal-edge-discovery-API-Readiness-Checklist.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/API_documentation/optimal-edge-discovery-API-Readiness-Checklist.md b/documentation/API_documentation/optimal-edge-discovery-API-Readiness-Checklist.md index 424c15a..dc1ba9b 100644 --- a/documentation/API_documentation/optimal-edge-discovery-API-Readiness-Checklist.md +++ b/documentation/API_documentation/optimal-edge-discovery-API-Readiness-Checklist.md @@ -1,12 +1,12 @@ # Optimal Edge Discovery API Readiness minimum criteria checklist -Checklist for Optimal-Edge-Discovery v0.1.0-rc.1 in r1.1 +Checklist for Optimal-Edge-Discovery v0.1.0 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|----| | 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/optimal-edge-discovery.yaml) | -| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | Comm. release r3.2 | -| 3 | Guidelines from ICM applied | O | M | M | M | Y | ICM release r3.2 | +| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/Commonalities/releases/tag/r3.3) | +| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.3) | | 4 | API versioning convention applied | M | M | M | M | Y | | | 5 | API documentation | M | M | M | M | Y | inline in YAML | | 6 | User stories | O | O | O | M | Y | [link](/documentation/API_documentation/optimal-edge-discovery-User-Story.md) | From 8c67ffa9e5faf2231039538f70cb63c537e67567 Mon Sep 17 00:00:00 2001 From: urvika-v Date: Thu, 28 Aug 2025 01:06:29 +0530 Subject: [PATCH 4/9] Update CHANGELOG.md --- CHANGELOG.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index cce6f22..f57d160 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,7 @@ ## Table of contents +- **[r1.2](#r12)** - **[r1.1 - rc](#r11---rc)** **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.** @@ -15,6 +16,27 @@ The below sections record the changes for each API version in each release as fo +# r1.2 + +## Release Notes + +This public release contains the definition and documentation of +* optimal-edge-discovery v0.1.0 + +The API definition(s) are based on +* Commonalities v0.6.0 (r3.3) +* Identity and Consent Management v0.4.0 (r3.3) + +- API definition with inline documentation: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/OptimalEdgeDiscovery/r1.2/code/API_definitions/optimal-edge-discovery.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/OptimalEdgeDiscovery/r1.2/code/API_definitions/optimal-edge-discovery.yaml) + - [OpenAPI YAML spec file](https://github.com/camaraproject/OptimalEdgeDiscovery/blob/r1.2/code/API_definitions/optimal-edge-discovery.yaml) + +### Added +* n/a +### Changed +* n/a + # r1.1 - rc ## Release Notes From 3fd19adcc7bd18b2cca7b3888520d3fd7b3bcafc Mon Sep 17 00:00:00 2001 From: urvika-v Date: Thu, 28 Aug 2025 01:15:15 +0530 Subject: [PATCH 5/9] Update README.md --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 66a8e31..2e6022d 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,13 @@ Sandbox API Repository to describe, develop, document, and test the OptimalEdgeD ## Release Information +* 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 public release**. +* **NEW: Latest public release [r1.2](https://github.com/camaraproject/OptimalEdgeDiscovery/releases/tag/r1.2) is available, with the following API version:** + * **optimal-edge-discovery v0.1.0** + [[YAML]](https://github.com/camaraproject/OptimalEdgeDiscovery/blob/r1.2/code/API_definitions/optimal-edge-discovery.yaml) + [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/OptimalEdgeDiscovery/r1.2/code/API_definitions/optimal-edge-discovery.yaml&nocors) + [[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/OptimalEdgeDiscovery/r1.2/code/API_definitions/optimal-edge-discovery.yaml) + Pre-releases of this sub project are available in https://github.com/camaraproject/OptimalEdgeDiscovery/releases From a1403ba916eb67ce69cc1f2f9ea649c0be44c877 Mon Sep 17 00:00:00 2001 From: Mahesh <98130650+maheshc01@users.noreply.github.com> Date: Wed, 27 Aug 2025 17:47:59 -0500 Subject: [PATCH 6/9] Update release information formatting in README --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2e6022d..ddfd27c 100644 --- a/README.md +++ b/README.md @@ -33,9 +33,9 @@ Sandbox API Repository to describe, develop, document, and test the OptimalEdgeD -Pre-releases of this sub project are available in https://github.com/camaraproject/OptimalEdgeDiscovery/releases -The latest public release is available here: https://github.com/camaraproject/OptimalEdgeDiscovery/releases/latest -For changes see [CHANGELOG.md](https://github.com/camaraproject/OptimalEdgeDiscovery/blob/main/CHANGELOG.md) +* Pre-releases of this sub project are available in https://github.com/camaraproject/OptimalEdgeDiscovery/releases +* The latest public release is available here: https://github.com/camaraproject/OptimalEdgeDiscovery/releases/latest +* For changes see [CHANGELOG.md](https://github.com/camaraproject/OptimalEdgeDiscovery/blob/main/CHANGELOG.md) ## Contributing From cc121578fb507410ccc2113c370f3ffee423c8d4 Mon Sep 17 00:00:00 2001 From: urvika-v Date: Mon, 15 Sep 2025 21:44:14 +0530 Subject: [PATCH 7/9] Updated documentation/API_documentation/optimal-edge-discovery-API-Readiness-Checklist.md Co-authored-by: Tanja de Groot <87864067+tanjadegroot@users.noreply.github.com> --- .../optimal-edge-discovery-API-Readiness-Checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API_documentation/optimal-edge-discovery-API-Readiness-Checklist.md b/documentation/API_documentation/optimal-edge-discovery-API-Readiness-Checklist.md index dc1ba9b..518d124 100644 --- a/documentation/API_documentation/optimal-edge-discovery-API-Readiness-Checklist.md +++ b/documentation/API_documentation/optimal-edge-discovery-API-Readiness-Checklist.md @@ -1,6 +1,6 @@ # Optimal Edge Discovery API Readiness minimum criteria checklist -Checklist for Optimal-Edge-Discovery v0.1.0 +Checklist for Optimal-Edge-Discovery v0.1.0 in r1.2 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|----| From 0fe8c3ed6ad91fb313055a4c04ffd70e81670b51 Mon Sep 17 00:00:00 2001 From: urvika-v Date: Mon, 15 Sep 2025 22:26:55 +0530 Subject: [PATCH 8/9] Updated ErrorInfo in optimal-edge-discovery.yaml --- code/API_definitions/optimal-edge-discovery.yaml | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/code/API_definitions/optimal-edge-discovery.yaml b/code/API_definitions/optimal-edge-discovery.yaml index debbc61..a5c0ee2 100644 --- a/code/API_definitions/optimal-edge-discovery.yaml +++ b/code/API_definitions/optimal-edge-discovery.yaml @@ -429,21 +429,20 @@ components: ErrorInfo: type: object - description: Error information required: - status - code - message properties: - message: - type: string - description: A human readable description of what the event represents status: type: integer description: HTTP response status code code: type: string - description: Friendly Code to describe the error + description: A human-readable code to describe the error + message: + type: string + description: A human-readable description of what the event represents OptimalEdgeDiscoveryInfo: description: | From e3609663c94a4d9a0ee522b0fd0eba2e4565edb3 Mon Sep 17 00:00:00 2001 From: urvika-v Date: Wed, 17 Sep 2025 14:18:19 +0530 Subject: [PATCH 9/9] Updated resource url in optimal-edge-discovery.feature --- code/Test_definitions/optimal-edge-discovery.feature | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/code/Test_definitions/optimal-edge-discovery.feature b/code/Test_definitions/optimal-edge-discovery.feature index e7016ba..5c3177c 100644 --- a/code/Test_definitions/optimal-edge-discovery.feature +++ b/code/Test_definitions/optimal-edge-discovery.feature @@ -2,10 +2,15 @@ Feature: CAMARA Optimal Edge Discovery API, v0.1.0 - Operations for discovering optimal edge cloud zones # Input to be provided by the implementation to the tests +# +# Implementation indications: +# * apiRoot: API root of the server URL +# # References to OAS spec schemas refer to schemas specified in optimal-edge-discovery.yaml Background: Common Optimal Edge Discovery setup - Given the resource "{apiroot}/optimal-edge-discovery/v0.1" as base-url + Given an environment at "apiRoot" + And the resource "/optimal-edge-discovery/v0.1" And the header "Content-Type" is set to "application/json" And the header "Authorization" is set to a valid access token And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator"