Skip to content

OptimalEdgeDiscovery r1.2 Fall25 M4 #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maheshc01 merged 9 commits into from
Sep 17, 2025
Merged

OptimalEdgeDiscovery r1.2 Fall25 M4 #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
60cd86b
Updated version to 0.1.0 in optimal-edge-discovery.yaml
urvika-v Aug 27, 2025
bee7080
Update version to 0.1.0 in optimal-edge-discovery.feature
urvika-v Aug 27, 2025
e14d3b8
Update versions of ICM/Com in optimal-edge-discovery-API-Readiness-Ch…
urvika-v Aug 27, 2025
8c67ffa
Update CHANGELOG.md
urvika-v Aug 27, 2025
3fd19ad
Update README.md
urvika-v Aug 27, 2025
a1403ba
Update release information formatting in README
maheshc01 Aug 27, 2025
cc12157
Updated documentation/API_documentation/optimal-edge-discovery-API-Re…
urvika-v Sep 15, 2025
0fe8c3e
Updated ErrorInfo in optimal-edge-discovery.yaml
urvika-v Sep 15, 2025
e360966
Updated resource url in optimal-edge-discovery.feature
urvika-v Sep 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.**
Expand All @@ -15,6 +16,27 @@ The below sections record the changes for each API version in each release as fo

<!--Repeat the below release section (header 1 and subsections) at the top of this file for each new (pre-)release-->

# 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
Expand Down
13 changes: 10 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<!-- Optional: an explicit listing of the latest (pre-)release with additional information, e.g. links to the API definitions -->
<!-- In addition use/uncomment one or multiple the following alternative options when becoming applicable -->
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

Expand Down
13 changes: 6 additions & 7 deletions code/API_definitions/optimal-edge-discovery.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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: |
Expand Down
9 changes: 7 additions & 2 deletions code/Test_definitions/optimal-edge-discovery.feature
View file
Open in desktop
Copy link
Contributor

@tanjadegroot tanjadegroot Sep 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All the error response tests could also include the line

  • And the response header "x-correlator" has same value as the request header "x-correlator"
    as well as
  • And the response property "$.message" contains a user friendly text

could be done for the next version.

Original file line number Diff line number Diff line change
@@ -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
Copy link
Contributor

@Kevsy Kevsy Sep 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# References to OAS spec schemas refer to schemas specified in optimal-edge-discovery.yaml
# Input to be provided by the implementation to the tester
#
# Implementation indications:
# * apiRoot: API root of the server URL
#
# References to OAS spec schemas refer to schemas specified in optimal-edge-discovery.yaml

Copy link
Contributor Author

@urvika-v urvika-v Sep 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @Kevsy for the comments . I have updated optimal-edge-discovery.feature


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"
Expand Down
6 changes: 3 additions & 3 deletions documentation/API_documentation/optimal-edge-discovery-API-Readiness-Checklist.md
View file
Open in desktop
Copy link
Contributor

@tanjadegroot tanjadegroot Sep 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You need to confirm that the API description is up-to-date across README, API yaml info.description, CAMARA website and API description in wiki.
See #22
I have the same issue with the use of the term "user" in the API description as above on the API yaml.

Copy link
Contributor

@maheshc01 maheshc01 Sep 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tanjadegroot made updates to wiki page to elaborate more and added/updated use cases and benefits.
Description in yaml is good.
README has only basic info and documentation is primarily in the yaml itself.
My understanding is that that content in the wiki will be used to update the CAMARA website. website update is not something all of us have access to update. Please correct me if this understanding is not right and we need to do any updates to website.

Copy link
Contributor

@maheshc01 maheshc01 Sep 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tanjadegroot Could you please let me know if we are all good with this. and if we have the approval to merge the code and create the public release.

Copy link
Contributor

@tanjadegroot tanjadegroot Sep 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tanjadegroot made updates to wiki page to elaborate more and added/updated use cases and benefits. Description in yaml is good. README has only basic info and documentation is primarily in the yaml itself. My understanding is that that content in the wiki will be used to update the CAMARA website. website update is not something all of us have access to update. Please correct me if this understanding is not right and we need to do any updates to website.

@maheshc01 yes that understanding is correct. The website is updated by the CAMARA marketing team based on the text in the Wiki in your API description page (link in the API Readiness Checklist. The actual update needs to be confirmed in the corresponding issue #22 (which was done) - thanks !

Copy link
Contributor

@tanjadegroot tanjadegroot Sep 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tanjadegroot Could you please let me know if we are all good with this. and if we have the approval to merge the code and create the public release.

@maheshc01 All done - you can proceed with the merge and release :-) thanks !

Original file line number Diff line number Diff line change
@@ -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<br>public | stable<br> 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) |
Expand Down