OptimalEdgeDiscovery r1.2 Fall25 M4#21
Conversation
urvika-v
requested review from
a team,
FabrizioMoggio,
JoseMConde,
Kevsy,
crissancas,
gainsley,
gunjald,
maheshc01 and
seralogar
as code owners
There was a problem hiding this comment.
Lines 13/14/23: I believe that the term "user" actually refers to the "API consumer" ?.
Do I understand correctly that this API consuming application is expected to be a management function of (other) applications deployed on clouds ?
If so, then it is not clear how devices would be associated to this API consuming application. ?
or is it the application deployed on cloud that uses this API in some embedded function which would allow to report "better" or additional deployment locations for this app to improve its coverage ?
Also what is the link with the SimpleEdgeDiscovery API ? the second endpoint of this API seems very similar.
There was a problem hiding this comment.
ErrorInfo schema definition: the "properties" section still lists the properties in the old order. it should be the same as in the "required" section.
There was a problem hiding this comment.
when displaying the yaml in the swagger UI, only the /regions endpoint is displayed.
The /retrieve-optimal-edge-cloud-zones is not visible.
I think the issue is that the second endpoint is interpreted as being part of the description field of the previous end-point as there is not white line between the 2.
please test by after updating the yaml - see: https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14559379/Release+Management+FAQ#How-to-view-the-yaml-file-of-a-not-yet-published-release-%3F
There was a problem hiding this comment.
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.
documentation/API_documentation/optimal-edge-discovery-API-Readiness-Checklist.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
@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.
There was a problem hiding this comment.
@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.
There was a problem hiding this comment.
@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 !
There was a problem hiding this comment.
@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 !
|
I just rechecked the swagger UI and it loads fine now. It was probably hidded by default under the description. |
…adiness-Checklist.md Co-authored-by: Tanja de Groot <87864067+tanjadegroot@users.noreply.github.com>
tanjadegroot
left a comment
tanjadegroot
left a comment
There was a problem hiding this comment.
Hi all, many thanks for the updates. All good !
LGTM from Release Management
|
|
||
| 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 |
There was a problem hiding this comment.
| Given the resource "{apiroot}/optimal-edge-discovery/v0.1" as base-url | |
| Given the resource "/optimal-edge-discovery/v0.1" |
| 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 |
There was a problem hiding this comment.
| # 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 |
There was a problem hiding this comment.
Thank you @Kevsy for the comments . I have updated optimal-edge-discovery.feature
tanjadegroot
left a comment
tanjadegroot
left a comment
There was a problem hiding this comment.
all good to go
LGTM from Release Management
|
thank you everyone. will merge and and create the public release. |
4 participants
What type of PR is this?
Add one of the following kinds:
What this PR does / why we need it:
Fall 25 M4 release
Which issue(s) this PR fixes:
Fixes #
Special notes for reviewers:
Changelog input
Additional documentation
This section can be blank.