Skip to content

Commit 2f3988a

Browse files
committed
Replacing a link to a PR with a link to the merged document.
Adding a note, that the state transition from activated to reserved is not in scope for initial release. Adding a section on API usage assumptions.
1 parent e808ba2 commit 2f3988a

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

documentation/SupportingDocuments/ApiDesignConsiderations.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# API Design Considerations
22

33
## 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.
55

66
## General Considerations
77
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
2222

2323
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.
2424

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+
2527
There can be different form of resources and capabilities:
2628
- It is essential for many use-cases to reserve connectivity capacity, e.g. expressed in aggregated throughput
2729
- 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
3739

3840
## Considerations for Monitoring
3941
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.
46+
- information about other API features.

0 commit comments

Comments
 (0)