Merge pull request #29 from deepakjaiswal1/main

Update BYON-Calling, BYON-RACM, BYON-Notification: resourceURL to sessionId/channelId
camaraproject · May 23, 2024 · 8ab2186 · 8ab2186
2 parents 30d1160 + 100b10e
commit 8ab2186
Show file tree

Hide file tree

Showing 3 changed files with 169 additions and 99 deletions.
diff --git a/code/API_definitions/BYON-CallHandling-Service.yaml b/code/API_definitions/BYON-CallHandling-Service.yaml
@@ -37,6 +37,14 @@ paths:
           application/json:
             schema:
               $ref: '#/components/schemas/VvoipSessionInformation'
+            example:
+              originatorAddress: tel:+17085852753
+              originatorName: tel:+17085852753
+              receiverAddress: tel:+17085854000
+              receiverName: tel:+17085854000
+              answer:
+                sdp: "v=0\r\no=- 8066321617929821805 2 IN IP4 127.0.0.1\r\ns=-\r\nt=0 0\r\nm=audio 42988 RTP/SAVPF 102 113\r\nc=IN IP6 2001:e0:410:2448:7a05:9b11:66f2:c9e\r\nb=AS:64\r\na=rtcp:9 IN IP4 0.0.0.0\r\na=candidate:1645903805 1 udp 2122262783 2001:e0:410:2448:7a05:9b11:66f2:c9e 42988 typ host generation 0 network-id 3 network-cost 900\r\na=ice-ufrag:4eKp\r\na=ice-pwd:D4sF5Pv9vx9ggaqxBlHbAFMx\r\na=ice-options:trickle renomination\r\na=mid:audio\r\na=extmap:2 http://www.ietf.org/id/draft-holmer-rmcat-transport-wide-cc-extensions-01\r\na=sendrecv\r\na=rtcp-mux\r\na=crypto:1 AES_CM_128_HMAC_SHA1_80 inline:Xm3YciqVIWFNSwy19e9MvfZ2YOdAZil7oT/tHjdf\r\na=rtpmap:102 AMR-WB/16000\r\na=fmtp:102 octet-align=0; mode-set=0,1,2; mode-change-capability=2\r\na=rtpmap:113 telephone-event/16000\r\n"
+              clientCorrelator: fda6e26d-e7c8-4596-870c-c083c0d39b2c
       responses:
         '400':
           $ref: '#/components/responses/Generic400'
@@ -50,22 +58,20 @@ paths:
         - BearerAuth:
             - read
             - write
-  /sessions/{sessionId}:
+  /sessions/{vvoipSessionId}:
     get:
       tags:
         - OneToOneCall
       summary: Get the vvoip session information
-      description: >
-        Get the VVoIP Session description based on sessionId.
-
+      description: |
+        Get the VVoIP Session description based on vvoipSessionId.
 
-        **Client shall use the resourceUrl supplied in the session creation
-        response (origination) or in the invitation notification (termination)**
+        ** The client shall construct the API path using the vvoipSessionId supplied in the session creation response (origination) or in the invitation notification (termination). **
       operationId: getSessionDetailsById
       parameters:
         - $ref: '#/components/parameters/hdrTransactionId'
         - $ref: '#/components/parameters/hdrClientId'
-        - $ref: '#/components/parameters/pathParamSessionId'
+        - $ref: '#/components/parameters/pathParamVvoipSessionId'
       responses:
         '200':
           description: A session information
@@ -98,15 +104,12 @@ paths:
 
         Terminate a 1-1 an ongoing vvoip session
 
-
-        **Client shall use the resourceUrl supplied in the session creation
-        response (origination) or in the invitation notification
-        (termination)**'
+        ** The client shall construct the API path using the vvoipSessionId supplied in the session creation response (origination) or in the invitation notification (termination). **'
       operationId: deleteSessionById
       parameters:
         - $ref: '#/components/parameters/hdrTransactionId'
         - $ref: '#/components/parameters/hdrClientId'
-        - $ref: '#/components/parameters/pathParamSessionId'
+        - $ref: '#/components/parameters/pathParamVvoipSessionId'
       responses:
         '204':
           description: Session deleted
@@ -124,19 +127,20 @@ paths:
         - BearerAuth:
             - read
             - write
-  /sessions/{sessionId}/status:
+  /sessions/{vvoipSessionId}/status:
     put:
       tags:
         - OneToOneCall
       summary: Update the status of the vvoip session
-      description: >
-        Update the status of the vvoip session, this may include updating SDP
-        media
+      description: |
+        Update the status of the vvoip session, this may include updating SDP media
+
+         ** The client shall construct the API path using the vvoipSessionId supplied in the session creation response (origination) or in the invitation notification (termination). **'
       operationId: postSessionStatus
       parameters:
         - $ref: '#/components/parameters/hdrTransactionId'
         - $ref: '#/components/parameters/hdrClientId'
-        - $ref: '#/components/parameters/pathParamSessionId'
+        - $ref: '#/components/parameters/pathParamVvoipSessionId'
       requestBody:
         content:
           application/json:
@@ -194,24 +198,10 @@ components:
           $ref: '#/components/schemas/WrtcsAnswer'
         clientCorrelator:
           type: string
-          description: >-
-            A correlator that the client can use to tag this particular resource
-            representation during a request to create a resource on the server.
-            Note - This allows the client to recover from communication failures
-            during resource creation and therefore avoids re-sending the message
-            in such situations. In case the element is present, the WebRTC GW
-            shall not alter its value, and shall provide it as part of the
-            representation of this resource.
-        resourceUrl:
+          description: A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server. Note - This allows the client to recover from communication failures during resource creation and therefore avoids re-sending the message in such situations. In case the element is present, the WebRTC GW shall not alter its value, and shall provide it as part of the representation of this resource.
+        vvoipSessionId:
           type: string
-          description: >-
-            Self referring URL. The resourceURL shall not be included in POST
-            requests by the client, but must be included in the notifications
-            from the WebRTC GW to client when a complete representation of the
-            resource is embedded in the notification. The resourceURL must also
-            be included in responses to any HTTP method that returns an entity
-            body, and in PUT requests
-          example: $url/{sessionId}
+          description: The VVOIP session ID created by WebRTC Gateway. The vvoipSessionID shall not be included in POST requests by the client, but must be included in the notifications from the WebRTC GW to client.
     SessionInvitationNotification:
       required:
         - originatorAddress
@@ -400,8 +390,8 @@ components:
       explode: false
       schema:
         type: string
-    pathParamSessionId:
-      name: sessionId
+    pathParamVvoipSessionId:
+      name: vvoipSessionId
       in: path
       description: The sessionId assigned by the WebRTC GW for the vvoip session
       required: true
@@ -418,8 +408,7 @@ components:
         receiverName: tel:+17085854000
         status: Initial
         clientCorrelator: fda6e26d-e7c8-4596-870c-c083c0d39b2c
-        resourceURL: >-
-          $url/sessions/0AEE1B58BAEEDA3EABA42B32EBB3DFE0DEAD3F90AE0CEB9EEB0C0F703E199FC00E7C6E648F50EE885FF0CE6C7E1CEE795EDD
+        vvoipSessionId: 0AEE1B58BAEEDA3EABA42B32EBB3DFE0DEAD3F90AE0CEB9EEB0C0F703E199FC00E7C6E648F50EE885FF0CE6C7E1CEE795EDD
     exMT183:
       value:
         receiverSessionStatus: