camaraproject / DedicatedNetworks

Repository to describe, develop, document and test the Service APIs for DedicatedNetworks
https://lf-camaraproject.atlassian.net/wiki/x/XIArAQ
Apache License 2.0
0 stars 3 forks source link

API Design Discussion #10

Open PeterKovacs2 opened 3 days ago

PeterKovacs2 commented 3 days ago

Problem description Let me kick off the technical discussions around designing this API.

Summary

DedicatedNetworks API should provide a complete solution to managing dedicated network resources in a MNOs network.

One of the functions of this API should be life-cycle management of these dedicated network resources:

But reserving resources alone has limited use if no-one can benefit from them. So I think this API should also consider managing device access to these resources:

Key Questions

  1. Are we in agreement about the expectations for this API?
  2. Are there specific constraints or requirements to consider?
tanjadegroot commented 3 days ago

Hi all, just a comment that the README.md page has a "standard" format for all APIs in the end and is not intended to reflect any discussions. Of course, while you are in design mode, the team can decide to use the README.md in this way, but in the end you will need to remove all discussion / questions when releasing the API.

Generally one or more issues like this one are used for the discussions and will also keep the history. The discussions would lead to a set of other issues that describe what needs to be done in PRs for progressing the API. These issues and their PRs would be then grouped in the Scope issue. I recommend to already create the Scope issue to which you can add the working issues and PRs as you go and agreed about the content of the API release.

And ... I just realized the comment I reacted to was created by an AI bot (pff). The account should probably be blocked on this repo, but up to you :-) I see it may have already been done as the comment disappeared.