Skip to content
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.

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

Topics/Questions for Meeting with commonalities #109

Closed
ThomasEXR opened this issue Jun 28, 2023 · 6 comments
Closed

Topics/Questions for Meeting with commonalities #109

ThomasEXR opened this issue Jun 28, 2023 · 6 comments

Comments

@ThomasEXR
Copy link
Contributor

As discussed let's collect all topics and questions for the meeting with Commonalities working group. Here are our topics, please add yours so we can cover all in the meeting.

1.) Authentication schemes
What authentication schemes are supposed to be used?
What options do exist for developer authentication?
What options do exist for device identification/authentication? (with 3GPP and non-3GPP access); are there reference implementations (e.g. for iOS/Android/...) for developers how to use it?

2.) Multi-operator handling
What is the proper way for developers to figure out which operator gateway to talk to? (using 3GPP and non-3GPP access)
Is there a reference implementation / documentation available?

3.) Common Data Model
Does Commonalities define a common data model for CAMARA, e.g. for device information, for location etc.?

4.) Naming conventions
Is there a document with common naming conventions to be used across CAMARA APIs?

5.) API release requirements
What are the official requirements for releasing an API? Is there a document describing that?
In terms of documentation, tests being conducted etc.

6.) API playground
Is there a common CAMARA API playground planned for developers to try out the CAMARA APIs? something like https://try-mec.etsi.org/ .

@Kevsy
Copy link
Collaborator

Kevsy commented Jun 28, 2023

7) Terminology and concepts

Commonalities to advise on the different taxonomies/names proposed
e.g.
--Cloudlet
----Edge Application,
------Application Edge Part,
--------Edge Application (part) instance
----------Application Edge Part instance Endpoint

vs 5GFF equivalent
--MEC platform
----Service Profile,
------Service Endpoint

Meaning and taxonomy of:
Regions
--Zones

(Comment removed as it relates rather to harmonisation, rather than release of Simple Edge Discovery)

@nicolacdnll
Copy link
Collaborator

3.) Common Data Model
Also for errors

1.) Authentication schemes + 3.) Common Data Model
Same authentication schemes across the board would be nice.

@Kevsy
Copy link
Collaborator

Kevsy commented Jul 4, 2023

4.) Naming conventions Is there a document with common naming conventions to be used across CAMARA APIs?

That's in the Design guidelines

5.) API release requirements What are the official requirements for releasing an API? Is there a document describing that? In terms of documentation, tests being conducted etc.

That's the API Readiness checklist

But we need to confirm that these documents are themselves final (or any outstanding issues with them)

@shilpa-padgaonkar
Copy link
Collaborator

@crissancas : As discussed, adding my response here as comment:

1.) Authentication schemes
This is covered here https://github.com/camaraproject/IdentityAndConsentManagement/blob/main/documentation/CAMARA-AuthN-AuthZ-Concept.md
Subprojects are free to extend the doc by first creating an issue in Identity-and-consent subproject and then creating a PR against it.
For the last 2 sub-questions, it would be great if you could kindly elaborate (more in a user story format, as it will be then easier to get the context.)

2.) Multi-operator handling
I would need some more details here. same as the last 2 questions in 1. It would be great if this is elaborated as this could be several options possible.

3.) Common Data and Errors in Camara can be found here https://github.com/camaraproject/Commonalities/blob/main/artifacts/CAMARA_common.json
Can be extended when needed.

4.) Naming conventions
https://github.com/camaraproject/Commonalities/blob/main/documentation/Glossary.md

5.) API release requirements
https://github.com/camaraproject/Commonalities/blob/main/documentation/API-Readiness-Checklist.md

6.) API playground
Until now, we have no such playground available.

General API design guidelines are available here https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md

Typically, if there is a more concrete problem that needs to be addressed by commonalities (as there is an opinion that it could also impact other subprojects) please create an issue in commonalities https://github.com/camaraproject/Commonalities/issues and attend one of the upcoming calls to pitch your topic in case it doesn't get traction by default.

Hope this helps.

@Kevsy
Copy link
Collaborator

Kevsy commented Jul 18, 2023

Thanks @shilpa-padgaonkar . We can remove (7) as it relates rather to the harmonisation activity.

Please can you confirm:

  • the template/process for 'API test cases' in the API Readiness checklist?
  • the security requirement for APIs that do not require consent? Is api_key in the definition sufficient?

Many thanks!

@Kevsy
Copy link
Collaborator

Kevsy commented Jan 23, 2024

Closed as these topics are now covered by Commonalities and Identity Consent guideline

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants