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 diff --git a/README.md b/README.md index 66a8e31..ddfd27c 100644 --- a/README.md +++ b/README.md @@ -24,11 +24,18 @@ 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 -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 diff --git a/code/API_definitions/optimal-edge-discovery.yaml b/code/API_definitions/optimal-edge-discovery.yaml index 3a97850..a5c0ee2 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 @@ -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: | diff --git a/code/Test_definitions/optimal-edge-discovery.feature b/code/Test_definitions/optimal-edge-discovery.feature index a662a80..5c3177c 100644 --- a/code/Test_definitions/optimal-edge-discovery.feature +++ b/code/Test_definitions/optimal-edge-discovery.feature @@ -1,11 +1,16 @@ @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 +# +# 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/vwip" 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" 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..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,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 in r1.2 | 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) |