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.

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

Jump to bottom

API Design Requirements #10

Open
PeterKovacs2 opened this issue Nov 18, 2024 · 2 comments · May be fixed by #15
Open

API Design Requirements #10

PeterKovacs2 opened this issue Nov 18, 2024 · 2 comments · May be fixed by #15
Labels
enhancement New feature or request

Comments

@PeterKovacs2
Copy link

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:

  • reservation
  • monitoring the state of reserved resources
  • release of no longer needed 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:

  • allow devices to access these resources
  • let devices know how they can select and access these resources

Key Questions

  1. Are we in agreement about the expectations for this API?
  2. Are there specific constraints or requirements to consider?
@PeterKovacs2 PeterKovacs2 added the enhancement New feature or request label Nov 18, 2024
@tanjadegroot
Copy link

tanjadegroot commented Nov 18, 2024 •
edited
Loading

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.

@PeterKovacs2 PeterKovacs2 changed the title API Design Discussion API Design Requirements Dec 2, 2024
@tlohmar tlohmar linked a pull request Dec 11, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

API design considerations tlohmar/DedicatedNetworks
3 participants
@tanjadegroot @PeterKovacs2 and others