Merge pull request #13 from ShutingQing/userStory

add user story

documentation/API_documentation/APIproposal_NetworkSlicing_ChinaUnicom.md

@@ -0,0 +1,13 @@
+| **Field** | Description | 
+| ---- | ----- |
+| API family name | Network Slicing API | 
+| API family owner | China Unicom, China Telecom, Huawei |
+| API family supporter | China Mobile, China Unicom, China Telecom, Huawei, TBD |
+| API summary | There are emerging requirements in high-rate time-critical applications in the areas of Cloud-gaming, AR/VR, Live Video Streaming, Real-time Multi-Media etc through mobile networks. The on-demand network slicing service technology can provide a network slice reservation method for such scenarios to meet the SLA assurance expected by developers for a specific time period and a dedicated service area. The Network Slicing API provides such abilities for developers to reserve, dynamically provisioning, query, dynamically destroy a slice with customized SLA assurance capabilities, customized service duration, expected slice covered locations and so on. <br /> <br /> Proposed API Definitions <br /> -Input Parameters:<br />Service Time：Start Time ~ End Time<br />Service Area：Geographical area (Point, Line, Area)<br />Guaranteed terminals：Number of terminals<br />SLA Targets：SLA KPIs (such as DL/UL Avg Throughput, Latency) <br /> <br /> -Output Parameters:<br />Slice Reservation Result： network slice reservation success (with Slice ID) or failure. <br /> <br /> An example: a developer may use this API to book a network slice with expected service time, expected service area, expected guaranteed numbers of terminals and expected SLA targets for 2 hours to 2 weeks in advance for some scheduled events like a live stream festival scheduled  in some place.|
+| Technical viability | This API requires the availability of RAN slicing, UDM, PCF, and network slicing management services as expressed in 3GPP TS 28.531 (network slice provisioning operations), TS 28.541 (Information model definitions for network slice NRM) standards.|
+| Commercial viability | Network Slicing has been commercialized in many fields. Static Slicing has helped operators monetized. Dynamic Slicing is on the way of huge potential value. It’s especially valuable in influencer live video stream, new media, power fiber scenario, industry fileds, there already appear many commercial use cases.| 
+| YAML code available? | No, needs to be provided in yaml. |
+| Validated in lab/productive environments? | Yes, in productive network. |
+| Validated with real customers? | Yes |
+| Validated with operators? | Yes , 3 operators participated in the evaluations. |
+| Others | More details can be refered in PPT. |

documentation/API_documentation/NSB_User_Story.md

@@ -0,0 +1,48 @@
+# Network Slice Booking (NSB) API User Story
+
+| **Field** | Description | 
+| ---- | ----- |
+| API family name | Network Slicing API |
+| API summary | There are emerging requirements in high-rate time-critical applications in the areas of Cloud-gaming, AR/VR, Live Video Streaming, Real-time Multi-Media etc through mobile networks. The on-demand network slicing service technology can provide a network slice reservation method for such scenarios to meet the SLA assurance expected by developers for a specific time period and a dedicated service area. The Network Slicing API provides such abilities for developers to reserve, dynamically provisioning, query, dynamically destroy a slice with customized SLA assurance capabilities, customized service duration, expected slice covered locations and so on. <br /> <br /> Proposed API Definitions <br /> -Input Parameters:<br />Service Time：Start Time ~ End Time<br />Service Area：Geographical area (Point, Line, Area)<br />Guaranteed terminals：Number of terminals<br />SLA Targets：SLA KPIs (such as DL/UL Avg Throughput, Latency) <br /> <br /> -Output Parameters:<br />Slice Reservation Result： network slice reservation success (with Slice ID) or failure. <br /> <br /> An example: a developer may use this API to book a network slice with expected service time, expected service area, expected guaranteed numbers of terminals and expected SLA targets for 2 hours to 2 weeks in advance for some scheduled events like a live stream festival scheduled  in some place.|
+| Technical viability | This API requires the availability of RAN slicing, UDM, PCF, and network slicing management services as expressed in 3GPP TS 28.531 (network slice provisioning operations), TS 28.541 (Information model definitions for network slice NRM) standards.|
+| Commercial viability | Network Slicing has been commercialized in many fields. Static Slicing has helped operators monetized. Dynamic Slicing is on the way of huge potential value. It’s especially valuable in influencer live video stream, new media, power fiber scenario, industry fileds, there already appear many commercial use cases.| 
+
+## ***Summary***
+
+There are emerging requirements in high-rate time-critical applications in the areas of Cloud-gaming, AR/VR, Live Video Streaming, Real-time Multi-Media etc through mobile networks. The on-demand network slicing service technology can provide a network slice reservation method for such scenarios to meet the SLA assurance expected by developers for a specific time period and a dedicated service area. The Network Slicing API provides such abilities for developers to reserve, dynamically provisioning, query, dynamically destroy a slice with customized SLA assurance capabilities, customized service duration, expected slice covered locations and so on.
+
+## ***Scenarios - Booking Scenario 1***
+
+**Operators:**
+
+Telecom Provide Network Slice Booking API on NaaS Platform or Aggregator Platform
+
+**API Consumers:** 
+
+OTT as API consumer. Eg: Tiktok
+1. TitTok book a bunch of slice resources using the "Slice Resource Booking" APIs. 
+ps: At this time, Tiktok may know or may not know about who would like buy "Dedicate/Premium Streaming Service" from Tiktok then.  
+
+**API End Users:**  
+
+OTT Customers Eg: Tiktok Influencer Studios 
+1. Influencers Companies or Studios may order "Dedicate/Premium Streaming Service" provided by Tiktok.
+2. Tiktok then help Influencer Companies on binding their devices into the Slice by calling the Network Slice Booking APIs.
+
+## ***Scenarios - Booking Scenario 2***
+
+**Operators:**
+
+Telecom Provide Network Slice Booking API on NaaS Platform or Aggregator Platform
+
+**API Consumers:** 
+
+Enterprises Developer. Eg: TV Station Developer
+1. TV Stations usually have grand TV Live Streaming Business. They need Slice Assurance Services to assure that they have dedicated network resources for their streaming. 
+2. TV Stations APP developer call Slice Assurance Services provided by Telecom NaaS Platform/Aggregator Platform directly. And developer make it "Streaming Assurance" function on the APP.
+
+**API End Users:**
+
+Enterprise. Eg: TV Station 
+1. Live Video Streaming Team One have a Live Streaming Task. Team One order the "Streaming Assurance" Service on TV Stations APP.
+2. Operator provide slice service on given the given date and area.