From 692b16411d86542aaad62d0d8d4fdf70c86ebc35 Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Tue, 24 Jun 2025 13:30:36 +0100 Subject: [PATCH 01/20] Updated version numbers for release candidate PR --- code/API_definitions/simple-edge-discovery.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/code/API_definitions/simple-edge-discovery.yaml b/code/API_definitions/simple-edge-discovery.yaml index 4ae9979..de5c111 100644 --- a/code/API_definitions/simple-edge-discovery.yaml +++ b/code/API_definitions/simple-edge-discovery.yaml @@ -2,7 +2,7 @@ openapi: 3.0.3 info: title: Simple Edge Discovery - version: wip + version: 2.0.0-rc.1 x-camara-commonalities: 0.6 description: | # Find the closest Edge Cloud Zone @@ -187,7 +187,7 @@ externalDocs: url: https://github.com/camaraproject/EdgeCloud servers: - - url: "{apiRoot}/simple-edge-discovery/vwip" + - url: "{apiRoot}/simple-edge-discovery/v2rc1" variables: apiRoot: default: https://localhost:9091 From 92456cb1a24dc8671fe80d805c42bd74a2f97977 Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Tue, 24 Jun 2025 13:53:59 +0100 Subject: [PATCH 02/20] Update CHANGELOG.md with r2.1 delta from r1.3 --- CHANGELOG.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0f1a02b..790515c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,7 @@ NOTE: ## Table of contents +- [r2.1 - rc](#r21---rc) - [r1.3](#r13) - [r1.2 - rc](#r12---rc) - [r1.1 - rc](#r11---rc) @@ -22,6 +23,50 @@ The below sections record the changes for each API version in each release as fo NOTE: SimpleEdgeDiscovery is part of the EdgeCloud API Sub Project, and was previously developed within the [EdgeCloud](https://github.com/camaraproject/EdgeCloud) repository. Two releases were made within EdgeCloud, v0.81 and r0.9.3-rc. These releases also include the other EdgeCloud APIs and materials, so the changelog below highlights only the changes related to SimpleEdgeDiscovery. Further information and links to the releases in EdgeCloud can be found below. +# r2.1 - rc + +This release candidate contains the definition and documentation of +* [simple-edge-discovery v2.0.0-rc.1]() + +The API definition(s) are based on +* Commonalities v0.6.0-rc.1 (r3.2) +* Identity and Consent Management v0.4.0-rc.1 (r3.2) + +It contains the **following breaking changes** compared to the last public release [r1.3](#r13): + +* The API's single operation has been refactored from GET to POST +* The operation resource URI has changed from `/edge-cloud-zones?filter=closest` to `/retrieve-closest-edge-cloud-zone` +* One or more device identifiers must be passed either via a 3-legged access token or in the request body. + +- API definition with inline documentation: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimpleEdgeDiscovery/r2.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/r2.1/code/API_definitions/simple-edge-discovery.yaml) + - [OpenAPI YAML spec file](https://github.com/camaraproject/SimpleEdgeDiscovery/blob/r2.1/code/API_definitions/simple-edge-discovery.yaml) + +### Added + +- [x] [Added DeviceResponse object #86](issues/86) +- [x] [Added section to documentation on non-documented errors #87](issues/87) +- [x] [Added Gherkin linter #95](issues/95) + +### Changed + +- [x] [Refactored discovery operation from GET to POST #74](issues/74) +- [x] [Updated User Story to reflect change from GET to POST #119](issues/119) +- [x] [Updated Gherkin `.feature` test scenarios to reflect change from GET to POST #79](issues/79) +- [x] [Refactored the operation's `200 OK` response to a `$ref` #76](issues/76) +- [x] [Refactored `x-correlator` schema to be a `$ref` and not defined inline #115](issues/115) +- [x] [Updated `x-correlator` pattern #88](issues/88) +- [x] [Updated `x-camara-commonalities` version to `0.6` #99](issues/99) +- [x] [Updated Gherkin `.feature` to test for a valid `x-correlator` #111](issues/111) + +### Removed + +- [x] [Removed `401 AUTHENTICATION REQUIRED` error #84](issues/84) +- [x] [Removed `422 IDENTIFIER MISMATCH` error #85](issues/85) + + + # r1.3 This release contains the definition and documentation of From 9822ed34424cce84eee5db01c8ac6f431a2a246a Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Thu, 26 Jun 2025 11:44:27 +0100 Subject: [PATCH 03/20] Added PR links for user-facing changes, added a 'Changed' section 'Changed' issues where originally under 'Added' --- CHANGELOG.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 790515c..cab4584 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -45,25 +45,24 @@ It contains the **following breaking changes** compared to the last public relea ### Added -- [x] [Added DeviceResponse object #86](issues/86) -- [x] [Added section to documentation on non-documented errors #87](issues/87) -- [x] [Added Gherkin linter #95](issues/95) +- [x] [Added DeviceResponse object #86](issues/86), [Pull Request #102](/pull/102) +- [x] [Added section to documentation on non-documented errors #87](issues/87), [Pull Request #102](/pull/112) ### Changed -- [x] [Refactored discovery operation from GET to POST #74](issues/74) -- [x] [Updated User Story to reflect change from GET to POST #119](issues/119) +- [x] [Refactored the API operation from GET to POST](issues/74), [Pull Request #78](/pull/78) +- [x] [Updated examples and usage description following refactoring to POST](/issues/75), [Pull Request #81](/pull/81) - [x] [Updated Gherkin `.feature` test scenarios to reflect change from GET to POST #79](issues/79) - [x] [Refactored the operation's `200 OK` response to a `$ref` #76](issues/76) - [x] [Refactored `x-correlator` schema to be a `$ref` and not defined inline #115](issues/115) -- [x] [Updated `x-correlator` pattern #88](issues/88) +- [x] [Updated `x-correlator` pattern #88](issues/88), [Pull Request #88](/pull/88) - [x] [Updated `x-camara-commonalities` version to `0.6` #99](issues/99) - [x] [Updated Gherkin `.feature` to test for a valid `x-correlator` #111](issues/111) ### Removed -- [x] [Removed `401 AUTHENTICATION REQUIRED` error #84](issues/84) -- [x] [Removed `422 IDENTIFIER MISMATCH` error #85](issues/85) +- [x] [Removed `401 AUTHENTICATION REQUIRED` error #84](issues/84), [Pull Request #90](/pull/90) +- [x] [Removed `422 IDENTIFIER MISMATCH` error #85](issues/85), [Pull Request #89](/pull/89) From 03ef08b9f889be0f2dcb1517522b40e2385e3f3d Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Thu, 26 Jun 2025 11:47:34 +0100 Subject: [PATCH 04/20] Minor formatting updates --- CHANGELOG.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index cab4584..dbc4a2b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -45,24 +45,24 @@ It contains the **following breaking changes** compared to the last public relea ### Added -- [x] [Added DeviceResponse object #86](issues/86), [Pull Request #102](/pull/102) -- [x] [Added section to documentation on non-documented errors #87](issues/87), [Pull Request #102](/pull/112) +- [x] [Added DeviceResponse object #86](issues/86), Pull Request [#102](/pull/102) +- [x] [Added section to documentation on non-documented errors #87](issues/87), Pull Request [#102](/pull/112) ### Changed -- [x] [Refactored the API operation from GET to POST](issues/74), [Pull Request #78](/pull/78) -- [x] [Updated examples and usage description following refactoring to POST](/issues/75), [Pull Request #81](/pull/81) +- [x] [Refactored the API operation from GET to POST](issues/74) Pull Request [#78](/pull/78) +- [x] [Updated examples and usage description following refactoring to POST](/issues/75), Pull Request [#81](/pull/81) - [x] [Updated Gherkin `.feature` test scenarios to reflect change from GET to POST #79](issues/79) - [x] [Refactored the operation's `200 OK` response to a `$ref` #76](issues/76) - [x] [Refactored `x-correlator` schema to be a `$ref` and not defined inline #115](issues/115) -- [x] [Updated `x-correlator` pattern #88](issues/88), [Pull Request #88](/pull/88) +- [x] [Updated `x-correlator` pattern #88](issues/88), Pull Request [#88](/pull/88) - [x] [Updated `x-camara-commonalities` version to `0.6` #99](issues/99) - [x] [Updated Gherkin `.feature` to test for a valid `x-correlator` #111](issues/111) ### Removed -- [x] [Removed `401 AUTHENTICATION REQUIRED` error #84](issues/84), [Pull Request #90](/pull/90) -- [x] [Removed `422 IDENTIFIER MISMATCH` error #85](issues/85), [Pull Request #89](/pull/89) +- [x] [Removed `401 AUTHENTICATION REQUIRED` error #84](issues/84), Pull Request [#90](/pull/90) +- [x] [Removed `422 IDENTIFIER MISMATCH` error #85](issues/85), Pull Request [#89](/pull/89) From 17b208d4f1fcdeed062d3db5e55195293239ffab Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Thu, 26 Jun 2025 11:59:06 +0100 Subject: [PATCH 05/20] Added API version to Feature name --- code/Test_definitions/simple-edge-discovery.feature | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/Test_definitions/simple-edge-discovery.feature b/code/Test_definitions/simple-edge-discovery.feature index 466cb57..39b3735 100644 --- a/code/Test_definitions/simple-edge-discovery.feature +++ b/code/Test_definitions/simple-edge-discovery.feature @@ -1,4 +1,4 @@ -Feature: CAMARA Simple Edge Discovery API - Operation readClosestEdgeCloudZone +Feature: CAMARA Simple Edge Discovery API, v2.0.0-rc.1 - Operation readClosestEdgeCloudZone Background: Given an environment at "apiRoot" From 62c140a685070596f0ccec5288bdd0fe7352ac11 Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Thu, 26 Jun 2025 12:00:21 +0100 Subject: [PATCH 06/20] Version updated to v2.0.0-rc.1 --- .../simple-edge-discovery_API_Readiness_Checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API_documentation/simple-edge-discovery_API_Readiness_Checklist.md b/documentation/API_documentation/simple-edge-discovery_API_Readiness_Checklist.md index 66b1deb..8945a2b 100644 --- a/documentation/API_documentation/simple-edge-discovery_API_Readiness_Checklist.md +++ b/documentation/API_documentation/simple-edge-discovery_API_Readiness_Checklist.md @@ -1,6 +1,6 @@ # API Readiness Checklist -Checklist for simple-edge-discovery v1.0.0 +Checklist for simple-edge-discovery v2.0.0-rc.1 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| From 2b94f3f12e18486016524dce629ad08348fadd99 Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Thu, 26 Jun 2025 14:16:03 +0100 Subject: [PATCH 07/20] Reformatted list of issues fixed into PR titles with absolute links --- CHANGELOG.md | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index dbc4a2b..a2d53e8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -45,25 +45,24 @@ It contains the **following breaking changes** compared to the last public relea ### Added -- [x] [Added DeviceResponse object #86](issues/86), Pull Request [#102](/pull/102) -- [x] [Added section to documentation on non-documented errors #87](issues/87), Pull Request [#102](/pull/112) +- [x] fix: added DeviceResponse object by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/102 +- [x] fix: added section on non-documented errors by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/87 ### Changed -- [x] [Refactored the API operation from GET to POST](issues/74) Pull Request [#78](/pull/78) -- [x] [Updated examples and usage description following refactoring to POST](/issues/75), Pull Request [#81](/pull/81) -- [x] [Updated Gherkin `.feature` test scenarios to reflect change from GET to POST #79](issues/79) -- [x] [Refactored the operation's `200 OK` response to a `$ref` #76](issues/76) -- [x] [Refactored `x-correlator` schema to be a `$ref` and not defined inline #115](issues/115) -- [x] [Updated `x-correlator` pattern #88](issues/88), Pull Request [#88](/pull/88) -- [x] [Updated `x-camara-commonalities` version to `0.6` #99](issues/99) -- [x] [Updated Gherkin `.feature` to test for a valid `x-correlator` #111](issues/111) +- [x] refactor!: move discovery operation from GET to POST by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/78 +- [x] docs: updated examples and usage description following refactoring to POST by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/81 +- [x] test: changed .feature tests to use POST by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/79 +- [x] fix: make operation's 200 OK response a ref by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/76 +- [x] fix: x-correlator changed to be a $ref to a schema object and not defined inline by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/115 +- [x] fix: updated x-correlator pattern by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/88 +- [x] fix: updated x-camara-commonalities to 0.6 by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/99 +- [x] test: Gherkin .feature updated to test for valid x-correlator by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/111 ### Removed -- [x] [Removed `401 AUTHENTICATION REQUIRED` error #84](issues/84), Pull Request [#90](/pull/90) -- [x] [Removed `422 IDENTIFIER MISMATCH` error #85](issues/85), Pull Request [#89](/pull/89) - +- [x] fix: removed 401 AUTHENTICATION_REQUIRED by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/90 +- [x] fix: removed 422 IDENTIFIER MISMATCH by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/89 # r1.3 From c5529af33ad53accf8a1f4d5d8af1b21b9dcfdd3 Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Thu, 26 Jun 2025 14:24:59 +0100 Subject: [PATCH 08/20] corrected wrong links --- CHANGELOG.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a2d53e8..d1409ed 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -46,18 +46,18 @@ It contains the **following breaking changes** compared to the last public relea ### Added - [x] fix: added DeviceResponse object by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/102 -- [x] fix: added section on non-documented errors by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/87 +- [x] fix: added section on non-documented errors by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/92 ### Changed -- [x] refactor!: move discovery operation from GET to POST by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/78 +- [x] refactor!: changed discovery operation method from GET to POST by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/78 - [x] docs: updated examples and usage description following refactoring to POST by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/81 -- [x] test: changed .feature tests to use POST by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/79 -- [x] fix: make operation's 200 OK response a ref by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/76 -- [x] fix: x-correlator changed to be a $ref to a schema object and not defined inline by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/115 -- [x] fix: updated x-correlator pattern by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/88 -- [x] fix: updated x-camara-commonalities to 0.6 by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/99 -- [x] test: Gherkin .feature updated to test for valid x-correlator by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/111 +- [x] refactor!: feature file updated to reflect change from GET to POST by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/118 +- [x] fix: updated 200 OK Response to a schema object by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/117 +- [x] fix: changed XCorrelator to an object and added resulting $refs by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/116 +- [x] fix: updated x-correlator pattern by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/93 +- [x] fix: updated x-camara-commonalities to 0.6 by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/101 +- [x] test: updated x-correlator in .feature to assert compliance with common schema by @Kevsy in https://github.com/camaraproject/SimpleEdgeDiscovery/pull/114 ### Removed From 5754be35c3c056c5799eb0075e2a18e3e45fc0de Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Tue, 1 Jul 2025 09:47:16 +0100 Subject: [PATCH 09/20] fix: commonalities & ICM releases, not versions --- .../simple-edge-discovery_API_Readiness_Checklist.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/API_documentation/simple-edge-discovery_API_Readiness_Checklist.md b/documentation/API_documentation/simple-edge-discovery_API_Readiness_Checklist.md index 8945a2b..df7f79c 100644 --- a/documentation/API_documentation/simple-edge-discovery_API_Readiness_Checklist.md +++ b/documentation/API_documentation/simple-edge-discovery_API_Readiness_Checklist.md @@ -5,8 +5,8 @@ Checklist for simple-edge-discovery v2.0.0-rc.1 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| | 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/simple-edge-discovery.yaml) | -| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | 0.6 | -| 3 | Guidelines from ICM applied | O | M | M | M | Y | 0.4 | +| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | r3.2 | +| 3 | Guidelines from ICM applied | O | M | M | M | Y | r3.2 | | 4 | API versioning convention applied | M | M | M | M | Y | | | 5 | API documentation | M | M | M | M | Y | in yaml | | 6 | User stories | O | O | O | M | Y | [link](/documentation/API_documentation/SimpleEdgeDiscovery_User_Story.md) | From 0e6bde4f5c19ff136e85ac6d1e86775984df37f4 Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Tue, 1 Jul 2025 09:57:27 +0100 Subject: [PATCH 10/20] fix: made Commonalities & ICM references links --- .../simple-edge-discovery_API_Readiness_Checklist.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/API_documentation/simple-edge-discovery_API_Readiness_Checklist.md b/documentation/API_documentation/simple-edge-discovery_API_Readiness_Checklist.md index df7f79c..fca6e65 100644 --- a/documentation/API_documentation/simple-edge-discovery_API_Readiness_Checklist.md +++ b/documentation/API_documentation/simple-edge-discovery_API_Readiness_Checklist.md @@ -5,8 +5,8 @@ Checklist for simple-edge-discovery v2.0.0-rc.1 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| | 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/simple-edge-discovery.yaml) | -| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | r3.2 | -| 3 | Guidelines from ICM applied | O | M | M | M | Y | r3.2 | +| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r3.2](https://github.com/camaraproject/Commonalities/releases/tag/r3.2) | +| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r3.2](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.2) | | 4 | API versioning convention applied | M | M | M | M | Y | | | 5 | API documentation | M | M | M | M | Y | in yaml | | 6 | User stories | O | O | O | M | Y | [link](/documentation/API_documentation/SimpleEdgeDiscovery_User_Story.md) | From 04c9e60c671ac78f4e02195ba56160806b601b7a Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Mon, 7 Jul 2025 10:46:14 +0100 Subject: [PATCH 11/20] fix: corrected `vwip` to `v2rc1` in resource URI --- code/Test_definitions/simple-edge-discovery.feature | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/Test_definitions/simple-edge-discovery.feature b/code/Test_definitions/simple-edge-discovery.feature index 39b3735..974fe26 100644 --- a/code/Test_definitions/simple-edge-discovery.feature +++ b/code/Test_definitions/simple-edge-discovery.feature @@ -2,7 +2,7 @@ Feature: CAMARA Simple Edge Discovery API, v2.0.0-rc.1 - Operation readClosestEd Background: Given an environment at "apiRoot" - And the resource "/simple-edge-discovery/vwip/retrieve-closest-edge-cloud-zone" | + And the resource "/simple-edge-discovery/v2rc1/retrieve-closest-edge-cloud-zone" | 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 dfa9d402472a09a7faf24be11069d1ae0da1bb21 Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Mon, 7 Jul 2025 12:25:48 +0100 Subject: [PATCH 12/20] fix: corrected template text for Additional Error Responses --- code/API_definitions/simple-edge-discovery.yaml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/code/API_definitions/simple-edge-discovery.yaml b/code/API_definitions/simple-edge-discovery.yaml index de5c111..f67fdfc 100644 --- a/code/API_definitions/simple-edge-discovery.yaml +++ b/code/API_definitions/simple-edge-discovery.yaml @@ -142,10 +142,12 @@ info: ### Additional CAMARA error responses The list of error codes in this API specification is not exhaustive. Therefore the API specification may not document some non-mandatory error statuses as - indicated in `CAMARA API Design Guidelines`. + indicated in `CAMARA API Design Guide`. Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated - to this API version for a complete list of error responses. + to this API version for a complete list of error responses. The applicable + Commonalities Release can be identified in the `API Readiness Checklist` document + associated to this API version. As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API. From 0de148c52bf0e683d4500a73503b64bac2c167e1 Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Mon, 7 Jul 2025 15:13:03 +0100 Subject: [PATCH 13/20] fix: remove the resource name from the scope --- code/API_definitions/simple-edge-discovery.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/API_definitions/simple-edge-discovery.yaml b/code/API_definitions/simple-edge-discovery.yaml index f67fdfc..c94a28a 100644 --- a/code/API_definitions/simple-edge-discovery.yaml +++ b/code/API_definitions/simple-edge-discovery.yaml @@ -207,7 +207,7 @@ paths: post: security: - openId: - - simple-edge-discovery:edge-cloud-zones:read + - simple-edge-discovery:read operationId: readClosestEdgeCloudZone parameters: - in: header From e6becf79ed993f72ca24807efdd6dcf41f6dba0c Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Thu, 17 Jul 2025 09:29:36 +0100 Subject: [PATCH 14/20] fix typo: succesfully->successfully --- code/Test_definitions/simple-edge-discovery.feature | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/Test_definitions/simple-edge-discovery.feature b/code/Test_definitions/simple-edge-discovery.feature index 974fe26..d472b8f 100644 --- a/code/Test_definitions/simple-edge-discovery.feature +++ b/code/Test_definitions/simple-edge-discovery.feature @@ -63,6 +63,6 @@ Feature: CAMARA Simple Edge Discovery API, v2.0.0-rc.1 - Operation readClosestEd @simple_edge_discovery_error_scenario_06_operator_cannot_resolve Scenario: Internal error at operator Given the request "readClosestEdgeCloudZone" is sent - And the device has been succesfully identified + And the device has been successfully identified When the operator is unable to resolve due to internal error Then the response code is 500 INTERNAL From f4b8064cb0295d4686aed2d9a1c76ae86f93262c Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Thu, 17 Jul 2025 09:35:15 +0100 Subject: [PATCH 15/20] Delete code/API_definitions/README.MD --- code/API_definitions/README.MD | 1 - 1 file changed, 1 deletion(-) delete mode 100644 code/API_definitions/README.MD diff --git a/code/API_definitions/README.MD b/code/API_definitions/README.MD deleted file mode 100644 index 04313f1..0000000 --- a/code/API_definitions/README.MD +++ /dev/null @@ -1 +0,0 @@ -Here you can add your definitions and delete this README.MD file From e46c0f190ee21e5553f59f218ed6bd3cd4fa627e Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Thu, 17 Jul 2025 09:46:59 +0100 Subject: [PATCH 16/20] Updated Release Information --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1bbfae8..2469552 100644 --- a/README.md +++ b/README.md @@ -23,11 +23,17 @@ Incubating API Repository to evolve and maintain the definitions and documentati ## Release Information -The latest public release is available here: https://github.com/camaraproject/SimpleEdgeDiscovery/releases/latest +* 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**. -Pre-releases of this sub project are available in https://github.com/camaraproject/SimpleEdgeDiscovery/releases +* **The latest public release candidate is [r2.1 - rc](https://github.com/camaraproject/QualityOnDemand/releases/tag/r2.2), with the following API version:** -For changes see [CHANGELOG.md](/CHANGELOG.md) + * **simple-edge-discovery v2.0.0-rc.1** + [[YAML]](https://github.com/camaraproject/SimpleEdgeDiscovery/blob/r2.1/code/API_definitions/simple-edge-discovery.yaml) + [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimpleEdgeDiscovery/r2.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/r2.1/code/API_definitions/simple-edge-discovery.yaml) + +* Previous releases and pre-releases are available [here](https://github.com/camaraproject/SimpleEdgeDiscovery/releases) +* For changes see [CHANGELOG.md](/CHANGELOG.md) ## Contributing * Meetings (as part of Edge Cloud Sub Project) From 4cb5aa22d70d6ed277d385a3ced86b54e58b2730 Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Thu, 17 Jul 2025 10:06:22 +0100 Subject: [PATCH 17/20] fix: removed accidental link --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d1409ed..a6188a1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -26,7 +26,7 @@ NOTE: SimpleEdgeDiscovery is part of the EdgeCloud API Sub Project, and was prev # r2.1 - rc This release candidate contains the definition and documentation of -* [simple-edge-discovery v2.0.0-rc.1]() +* simple-edge-discovery v2.0.0-rc.1 The API definition(s) are based on * Commonalities v0.6.0-rc.1 (r3.2) From 42c904b256cb90bb52710efe2f3c87ffc400c471 Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Thu, 17 Jul 2025 10:51:06 +0100 Subject: [PATCH 18/20] fixed URL to release tag --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2469552..1fda8c3 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ 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 public release**. -* **The latest public release candidate is [r2.1 - rc](https://github.com/camaraproject/QualityOnDemand/releases/tag/r2.2), with the following API version:** +* **The latest public release candidate is [r2.1 - rc](https://github.com/camaraproject/SimpleEdgeDiscovery/releases/tag/r2.2), with the following API version:** * **simple-edge-discovery v2.0.0-rc.1** [[YAML]](https://github.com/camaraproject/SimpleEdgeDiscovery/blob/r2.1/code/API_definitions/simple-edge-discovery.yaml) From 5a330de2c569a6e584f3e779942ef81a6eb65f8c Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Fri, 18 Jul 2025 16:01:58 +0100 Subject: [PATCH 19/20] fixed public release -> pre-release --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1fda8c3..df0ba31 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ 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 public release**. -* **The latest public release candidate is [r2.1 - rc](https://github.com/camaraproject/SimpleEdgeDiscovery/releases/tag/r2.2), with the following API version:** +* **The latest pre-release is [r2.1 - rc](https://github.com/camaraproject/SimpleEdgeDiscovery/releases/tag/r2.2), with the following API version:** * **simple-edge-discovery v2.0.0-rc.1** [[YAML]](https://github.com/camaraproject/SimpleEdgeDiscovery/blob/r2.1/code/API_definitions/simple-edge-discovery.yaml) From 380e09cb6c5c3344c389e1bdd4cc28a4e8721667 Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Tue, 22 Jul 2025 15:03:52 +0100 Subject: [PATCH 20/20] fix: tag 2.2->2.1 Co-authored-by: Rafal Artych <121048129+rartych@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index df0ba31..d039f45 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ 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 public release**. -* **The latest pre-release is [r2.1 - rc](https://github.com/camaraproject/SimpleEdgeDiscovery/releases/tag/r2.2), with the following API version:** +* **The latest pre-release is [r2.1 - rc](https://github.com/camaraproject/SimpleEdgeDiscovery/releases/tag/r2.1), with the following API version:** * **simple-edge-discovery v2.0.0-rc.1** [[YAML]](https://github.com/camaraproject/SimpleEdgeDiscovery/blob/r2.1/code/API_definitions/simple-edge-discovery.yaml)