Scope of Simple Edge Discovery for Fall24 CAMARA release

[Kevsy]

This issue shall define which issues are within scope of the API of the Simple Edge Discovery Sub Project for the Fall24 release, and will be regularly updated based on the decision within the EdgeCloud meetings.

Alignment with Commonalities 0.4 and ICM

• Alignment of x-correlator format with Commonalities 0.4.0  #33
• Remove 405 Method Not Allowed #34
• Update documentation for AuthN/AuthZ in line with Identity & Consent Management #35
• Remove telco-centric term 'MNO' #36
• Proposal to simplify device object and improve interoperability Commonalities#233
• API Design Guidelines chapter 11: 'info' object, 'servers' object and cleanup  Commonalities#214
• error_model_alignment Commonalities#213
• Enhance API-Testing-Guidelines.md Commonalities#203
• update-design-doc-with-explicit-sub-scope-changes Commonalities#177
• x-correlator_support_guidelines_in_notifications Commonalities#170
• Update API Design Guidelines on usage and style of operation tags Commonalities#152
• Need new API Readiness Checklist  #22
• Simple Edge Discovery needs to implement consent guidelines #21
• Simple Edge Discovery needs to include X-Correlator header #20
• Simple Edge Discovery to comply with Commonalities Device Identifier schema #15
• Create Simple_Edge_Discovery_User_story.md EdgeCloud#119

Resource model name/structure changes aligned with EdgeCloud

• Simple Edge Discovery to use the agreed Edge Cloud Zones schema from Discussion #14
• Simple Edge Discovery: edgeCloudZones collection array does not contain edgeCloudZone objects #17
• Simple Edge Discovery to rename MECPlatform to EdgeCloudZone #18
• Harmonization of Edge Entitys among EdgeCloud APIS for future merge EdgeCloud#163

Documentation

• Documentation: Clarify distinction between device/server usage of Simple Edge Discovery API EdgeCloud#207

API Release Criteria

• Simple Edge Discovery requires User Story #16
• Simple Edge Discovery needs Gherkin .feature file #19

[hdamker]

@Kevsy would you like to transfer the issues from EdgeCloud into the SimpleEdgeDiscovery repository?

As you have write access to both repositories you can do it yourself, using the "Transfer issue" on the right column. Links to the previous location will be automatically redirected to the new location, so no problems with broken links in minutes etc.

[eric-murray]

@Kevsy
x-correlator is still defined with format: uuid in v0.11.0-rc.1, but Commonalities removed this restriction in v0.4.0. So x-correlator can now be any string.

[Kevsy]

@Kevsy x-correlator is still defined with format: uuid in v0.11.0-rc.1, but Commonalities removed this restriction in v0.4.0. So x-correlator can now be any string.

Thanks @eric-murray - raised in #33 for M4

[hdamker]

@Kevsy don't forget the fix for #33

[Kevsy]

@Kevsy don't forget the fix for #33

Thanks - added to the scope above

[Kevsy]

Added the following issues to the scope.

• Remove 405 Method Not Allowed #34
• Update documentation for AuthN/AuthZ in line with Identity & Consent Management #35
• Remove telco-centric term 'MNO' #36

[hdamker]

@Kevsy When creating the release PR for M4, please set the version therein to 1.0.0, not 0.11.0 -- assuming that you still consider to release a stable version. It would be great if you would also update the title and target version field on https://wiki.camaraproject.org/display/CAM/simple-edge-discovery+v0.11.0 already now to have a clear status there.

[Kevsy]

@Kevsy When creating the release PR for M4, please set the version therein to 1.0.0, not 0.11.0 -- assuming that you still consider to release a stable version.

Sure - just to clarify, you are not asking me to change the current PR #37 for v0.11.0-rc.2 - but rather to make sure the eventual release PR for M4 states uses v1.0.0 , correct?

It would be great if you would also update the title and target version field on https://wiki.camaraproject.org/display/CAM/simple-edge-discovery+v0.11.0 already now to have a clear status there.

Yes, I can change that now

[Kevsy]

@Kevsy When creating the release PR for M4, please set the version therein to 1.0.0, not 0.11.0 -- assuming that you still consider to release a stable version.

Sure @hdamker - just to clarify, you are not asking me to change the current PR #37 for v0.11.0-rc.2 - but rather to make sure the eventual release PR for M4 states uses v1.0.0 , correct?

It would be great if you would also update the title and target version field on https://wiki.camaraproject.org/display/CAM/simple-edge-discovery+v0.11.0 already now to have a clear status there.

Yes, I can change that now

[hdamker]

Sure @hdamker - just to clarify, you are not asking me to change the current PR #37 for v0.11.0-rc.2 - but rather to make sure the eventual release PR for M4 states uses v1.0.0 , correct?

Yes, correct. We should just get #37 merged soon, as the "eventual release PR for M4" is already due on Monday :-)

[Kevsy]

Thanks @hdamker - so I can merge #37 now, release with tag r1.2, and then prepare the release PR for M4 by the Monday deadline :)

[hdamker]

Thanks @hdamker - so I can merge #37 now, release with tag r1.2, and then prepare the release PR for M4 by the Monday deadline :)

Unfortunately you have merged #37 without addressing my comment that the CHANGELOG need to be updated. A release tag without documenting the changes compared to r1.1 is not very useful.

Would you mind to do another short PR with the CHANGELOG update before you create the r1.2 with the 0.11.0-rc.2 API version?

[hdamker]

@Kevsy thanks for #38 ... so you are now ready to create the release with the r1.2 tag 👍

[Kevsy]

@hdamker Thanks, my mistake 🤦‍♂️ - also thanks to @javierlozallu for the fast approval.

I will make the release and then prepare the PR for M4 per the instructions - Monday is a UK bank holiday so will get it done today...

[hdamker]

@Kevsy I suppose that this issue is done and can be closed. Consider to start planning for Spring25 😄

[Kevsy]

Thanks Herbert and all the contributors for getting this issue closed :)