You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: documentation/SupportingDocuments/ApiDesignConsiderations.md
+8-1
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
# API Design Considerations
2
2
3
3
## Introduction
4
-
The API design considerations are derived from the API usage scenarios (PR#12). The aim of the API is to hide telco specific complexity, while offering the needed capabilities. There may be different realization of the needed network capabilities, e.g. using shared network slices or even exclusive network slices.
4
+
The API design considerations are derived from the API [usage scenarios](UsageScenarios.md). The aim of the API is to hide telco specific complexity, while offering the needed capabilities. There may be different realization of the needed network capabilities, e.g. using shared network slices or even exclusive network slices.
5
5
6
6
## General Considerations
7
7
The API should allow combination with other CAMARA APIs, such as QOD, Connectivity Insights / Monitoring, etc.
@@ -22,6 +22,8 @@ Reservation of resources should allow for time and location (service area) limit
22
22
23
23
The Network Provider should control the state transition from *requested* state to either *reserved*, *activated* or *terminated* state. The state transition from *reserved* to *activated* is triggered by the reservation start time. The state transition from *activated* to either *reserved* or *terminated* is triggered by the reservation end time. The API consumer should get notified upon state-transitions.
24
24
25
+
Note: Functionality to trigger state transition from *activated* back to *reserved* state is not in scope of the initial API, but mentioned for completeness.
26
+
25
27
There can be different form of resources and capabilities:
26
28
- It is essential for many use-cases to reserve connectivity capacity, e.g. expressed in aggregated throughput
27
29
- Several use cases require usage of different network capabilities, like for providing Quality on Demand (QOD) or connectivity monitoring, etc.
@@ -37,3 +39,8 @@ Devices, which have access to the dedicated network, will use one of the pre-sel
37
39
38
40
## Considerations for Monitoring
39
41
There are several potential relevant CAMARA APIs for monitoring, e.g. Connectivity Insights, Connectivity Insights Subscriptions, Session Insights, Device Status, Device Quality Indication, …
42
+
43
+
## Assumptions for API usage
44
+
There are several pre-steps outside of the Dedicated Network API scope. These are for example
45
+
- API consumer on-boarding, specifically obtaining API access credentials.
0 commit comments