Added support for optional user display name in typing notifications …

…API. (#14746) Co-authored-by: Camilo Ramirez <juramir@microsoft.com>
Azure · Jun 10, 2021 · 80f16dd · 80f16dd
1 parent ef7ffaa
commit 80f16dd
Show file tree

Hide file tree

Showing 2 changed files with 89 additions and 63 deletions.
diff --git a/.../communication/data-plane/Chat/preview/2021-04-05-preview6/communicationserviceschat.json b/.../communication/data-plane/Chat/preview/2021-04-05-preview6/communicationserviceschat.json
@@ -537,68 +537,6 @@
         }
       }
     },
-    "/chat/threads/{chatThreadId}/typing": {
-      "post": {
-        "tags": [
-          "Messages"
-        ],
-        "summary": "Posts a typing event to a thread, on behalf of a user.",
-        "operationId": "ChatThread_SendTypingNotification",
-        "produces": [
-          "application/json"
-        ],
-        "parameters": [
-          {
-            "in": "path",
-            "name": "chatThreadId",
-            "description": "Id of the thread.",
-            "required": true,
-            "type": "string"
-          },
-          {
-            "$ref": "#/parameters/ApiVersionParameter"
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "Request successful."
-          },
-          "401": {
-            "description": "Unauthorized.",
-            "schema": {
-              "$ref": "#/definitions/CommunicationErrorResponse"
-            },
-            "x-ms-error-response": true
-          },
-          "403": {
-            "description": "Forbidden.",
-            "schema": {
-              "$ref": "#/definitions/CommunicationErrorResponse"
-            },
-            "x-ms-error-response": true
-          },
-          "429": {
-            "description": "Too many requests.",
-            "schema": {
-              "$ref": "#/definitions/CommunicationErrorResponse"
-            },
-            "x-ms-error-response": true
-          },
-          "503": {
-            "description": "Service unavailable.",
-            "schema": {
-              "$ref": "#/definitions/CommunicationErrorResponse"
-            },
-            "x-ms-error-response": true
-          }
-        },
-        "x-ms-examples": {
-          "Post typing event to a thread": {
-            "$ref": "./examples/Messages_SendTypingNotification.json"
-          }
-        }
-      }
-    },
     "/chat/threads/{chatThreadId}/participants": {
       "get": {
         "tags": [
@@ -1183,6 +1121,80 @@
           }
         }
       }
+    },
+    "/chat/threads/{chatThreadId}/typing": {
+      "post": {
+        "tags": [
+          "TypingNotifications"
+        ],
+        "summary": "Posts a typing event to a thread, on behalf of a user.",
+        "operationId": "ChatThread_SendTypingNotification",
+        "consumes": [
+          "application/json",
+          "application/merge-patch+json"
+        ],
+        "produces": [
+          "application/json"
+        ],
+        "parameters": [
+          {
+            "in": "path",
+            "name": "chatThreadId",
+            "description": "Id of the thread.",
+            "required": true,
+            "type": "string"
+          },
+          {
+            "$ref": "#/parameters/ApiVersionParameter"
+          },
+          {
+            "in": "body",
+            "name": "sendTypingNotificationRequest",
+            "description": "Details of the typing notification request.",
+            "schema": {
+              "$ref": "#/definitions/SendTypingNotificationRequest"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Request successful."
+          },
+          "401": {
+            "description": "Unauthorized.",
+            "schema": {
+              "$ref": "#/definitions/CommunicationErrorResponse"
+            },
+            "x-ms-error-response": true
+          },
+          "403": {
+            "description": "Forbidden.",
+            "schema": {
+              "$ref": "#/definitions/CommunicationErrorResponse"
+            },
+            "x-ms-error-response": true
+          },
+          "429": {
+            "description": "Too many requests.",
+            "schema": {
+              "$ref": "#/definitions/CommunicationErrorResponse"
+            },
+            "x-ms-error-response": true
+          },
+          "503": {
+            "description": "Service unavailable.",
+            "schema": {
+              "$ref": "#/definitions/CommunicationErrorResponse"
+            },
+            "x-ms-error-response": true
+          }
+        },
+        "x-ms-examples": {
+          "Post typing event to a thread": {
+            "$ref": "./examples/Messages_SendTypingNotification.json"
+          }
+        }
+      }
     }
   },
   "definitions": {
@@ -1665,6 +1677,17 @@
           "example": "Lunch Thread"
         }
       }
+    },
+    "SendTypingNotificationRequest": {
+      "description": "Request payload for typing notifications.",
+      "type": "object",
+      "properties": {
+        "senderDisplayName": {
+          "description": "The display name of the typing notification sender. This property is used to populate sender name for push notifications.",
+          "type": "string",
+          "example": "Bob Admin"
+        }
+      }
     }
   },
   "parameters": {

diff --git a/...data-plane/Chat/preview/2021-04-05-preview6/examples/Messages_SendTypingNotification.json b/...data-plane/Chat/preview/2021-04-05-preview6/examples/Messages_SendTypingNotification.json
@@ -2,7 +2,10 @@
   "parameters": {
     "endpoint": "https://contoso.westus.communications.azure.com",
     "api-version": "2021-04-05-preview6",
-    "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"
+    "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+    "sendTypingNotificationRequest": {
+      "senderDisplayName": "Jane"
+    }
   },
   "responses": {
     "200": {},