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

API design considerations #15

Merged
merged 1 commit into from
Feb 3, 2025

Conversation

tlohmar
Copy link
Contributor

@tlohmar tlohmar commented Dec 11, 2024

What type of PR is this?

Add one of the following kinds:

  • documentation

What this PR does / why we need it:

The PR provides a first draft of a API Design considerations document. Having a document allows to drive enhancements via Pull Requests and have a consistent view with collection of latest views.

Which issue(s) this PR fixes:

Fixes #10

Special notes for reviewers:

Changelog input

 release-note

Additional documentation

This section can be blank.

docs

@SteveV-Vodafone
Copy link

I'm a little confused by the transition from Activated to Reserved based on Reservation end time described in line 23. Does this imply that a user of the API can request a Dedicated Network for a series of separate times in a single request? (e.g. every Wednesday from 9-10am) Or is there some other use case that requires a reservation that can move back to "reserved" after activated.

@tlohmar
Copy link
Contributor Author

tlohmar commented Jan 8, 2025

@SteveV-Vodafone: Good catch. Indeed, one motivation would be to address use cases with recurring reservations. Not yet sure, whether handling of reoccurrence becomes too complicated.

Copy link

@SteveV-Vodafone SteveV-Vodafone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Further detail on recurring reservations will be needed later (e.g. the transition from Active back to Reserved). Recommend we exclude this option from first release (as it can be managed externally by using multiple reservations).

Having a single reservation for multiple time slots may make it hard to report on performance if a single ID is used to identify the reservation. E.g. if a developer queries "was my SLA met for reservation XYZ" how can we answer if the reservation is not complete as it recurs every Wednesday?

eric-murray
eric-murray previously approved these changes Jan 23, 2025
@tlohmar tlohmar dismissed eric-murray’s stale review January 27, 2025 09:13

The merge-base changed after approval.

@tlohmar tlohmar closed this Jan 27, 2025
@tlohmar tlohmar force-pushed the api-design-considerations branch from 6eed805 to 69b8e95 Compare January 27, 2025 13:57
@tlohmar tlohmar reopened this Jan 27, 2025
@tlohmar
Copy link
Contributor Author

tlohmar commented Jan 27, 2025

resolving conflict.
@eric-murray: please re-approve.

@tlohmar tlohmar merged commit e808ba2 into camaraproject:main Feb 3, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

API Design Requirements
4 participants