Added new specification for chat - release 2020-11-01-preview3 (#11716)

* Added new specification for chat - release 2020-11-01-preview3

* Addressing feedback

* Updating max page size parameter name

* update `maxpagesize` parameter name in example file.

* Runn prettier on examples

* Removing obsolete example files, and adding missing description properties.

* Update `maxpagesize` query parameter name for `ListChatThreads`

* rename $maxpagesize to `maxPageSize`

Co-authored-by: Camilo Ramirez <[email protected]>
Co-authored-by: Amr Elroumy <[email protected]>

Author: 3 people

specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json

@@ -0,0 +1,51 @@
+{
+  "parameters": {
+    "endpoint": "https://contoso.westus.communications.azure.com",
+    "api-version": "2020-11-01-preview3",
+    "chatThreadId": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2",
+    "$maxpagesize": 2
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "value": [
+          {
+            "senderId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b",
+            "chatMessageId": "1591137790240",
+            "readOn": "2020-06-06T05:55:41.6460000Z"
+          },
+          {
+            "senderId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c00a",
+            "chatMessageId": "1591768249318",
+            "readOn": "2020-06-06T05:55:41.6460000Z"
+          }
+        ],
+        "nextLink": "https://contoso.westus.communications.azure.com/chat/threads/19:[email protected]/readReceipts?skip=2&$maxpagesize=2&api-version=2020-11-01-preview3"
+      }
+    },
+    "401": {
+      "body": {
+        "code": "Unauthorized",
+        "message": "Request is not authorized."
+      }
+    },
+    "403": {
+      "body": {
+        "code": "Forbidden",
+        "message": "User is not allowed to perform specified action."
+      }
+    },
+    "429": {
+      "body": {
+        "code": "TooManyRequests",
+        "message": "Rate limit exceeded."
+      }
+    },
+    "503": {
+      "body": {
+        "code": "ServiceUnavailable",
+        "message": "The server is currently unable to handle the request."
+      }
+    }
+  }
+}

specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Conversations_ListChatReadReceiptsWithPageSize.json

@@ -0,0 +1,37 @@
+{
+  "parameters": {
+    "endpoint": "https://contoso.westus.communications.azure.com",
+    "api-version": "2020-11-01-preview3",
+    "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+    "sendReadReceiptRequest": {
+      "chatMessageId": "1591137790240"
+    }
+  },
+  "responses": {
+    "201": {},
+    "401": {
+      "body": {
+        "code": "Unauthorized",
+        "message": "Request is not authorized."
+      }
+    },
+    "403": {
+      "body": {
+        "code": "Forbidden",
+        "message": "User is not allowed to perform specified action."
+      }
+    },
+    "429": {
+      "body": {
+        "code": "TooManyRequests",
+        "message": "Rate limit exceeded."
+      }
+    },
+    "503": {
+      "body": {
+        "code": "ServiceUnavailable",
+        "message": "The server is currently unable to handle the request."
+      }
+    }
+  }
+}

specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Conversations_SendChatReadReceipt.json

@@ -0,0 +1,35 @@
+{
+  "parameters": {
+    "endpoint": "https://contoso.westus.communications.azure.com",
+    "api-version": "2020-11-01-preview3",
+    "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+    "chatMessageId": "1591768249318"
+  },
+  "responses": {
+    "204": {},
+    "401": {
+      "body": {
+        "code": "Unauthorized",
+        "message": "Request is not authorized."
+      }
+    },
+    "403": {
+      "body": {
+        "code": "Forbidden",
+        "message": "User is not allowed to perform specified action."
+      }
+    },
+    "429": {
+      "body": {
+        "code": "TooManyRequests",
+        "message": "Rate limit exceeded."
+      }
+    },
+    "503": {
+      "body": {
+        "code": "ServiceUnavailable",
+        "message": "The server is currently unable to handle the request."
+      }
+    }
+  }
+}

specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_DeleteChatMessage.json

@@ -0,0 +1,46 @@
+{
+  "parameters": {
+    "endpoint": "https://contoso.westus.communications.azure.com",
+    "api-version": "2020-11-01-preview3",
+    "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+    "chatMessageId": "1591768249318"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "id": "1591768249318",
+        "type": "Text",
+        "version": "1599016601134",
+        "priority": "Normal",
+        "content": "Let's head out for lunch in 15 minutes.",
+        "senderDisplayName": "Jane",
+        "createdOn": "2020-06-10T05:50:49.3180000Z",
+        "senderId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b"
+      }
+    },
+    "401": {
+      "body": {
+        "code": "Unauthorized",
+        "message": "Request is not authorized."
+      }
+    },
+    "403": {
+      "body": {
+        "code": "Forbidden",
+        "message": "User is not allowed to perform specified action."
+      }
+    },
+    "429": {
+      "body": {
+        "code": "TooManyRequests",
+        "message": "Rate limit exceeded."
+      }
+    },
+    "503": {
+      "body": {
+        "code": "ServiceUnavailable",
+        "message": "The server is currently unable to handle the request."
+      }
+    }
+  }
+}

specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_GetChatMessage.json

@@ -0,0 +1,89 @@
+{
+  "parameters": {
+    "endpoint": "https://contoso.westus.communications.azure.com",
+    "api-version": "2020-11-01-preview3",
+    "chatThreadId": "19:[email protected]",
+    "$maxpagesize": 5
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "value": [
+          {
+            "id": "1593107077690",
+            "type": "Text",
+            "priority": "Normal",
+            "version": "1593107077683",
+            "content": "So where should we get lunch from today?",
+            "senderDisplayName": "Jane",
+            "createdOn": "2020-06-25T17:44:37.6830000Z",
+            "senderId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b"
+          },
+          {
+            "id": "1593107077683",
+            "type": "Text",
+            "priority": "Normal",
+            "version": "1593107077683",
+            "content": "Let's use this chat to decide what to get for lunch today.",
+            "senderDisplayName": "Jane",
+            "createdOn": "2020-06-25T17:44:37.6830000Z",
+            "senderId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b"
+          },
+          {
+            "id": "1593107046498",
+            "type": "Text",
+            "priority": "Normal",
+            "version": "1593107046498",
+            "content": "Good morning everyone!",
+            "senderDisplayName": "Jane",
+            "createdOn": "2020-06-25T17:44:06.4980000Z",
+            "senderId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b"
+          },
+          {
+            "id": "1593106976785",
+            "type": "ThreadActivity/TopicUpdate",
+            "priority": "Normal",
+            "version": "1593106976785",
+            "content": "<topicupdate><eventtime>1593106976785</eventtime><initiator>8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b</initiator><value>Lunch</value></topicupdate>",
+            "createdOn": "2020-06-25T17:42:56.7850000Z",
+            "senderId": "19:[email protected]"
+          },
+          {
+            "id": "1593106976753",
+            "type": "ThreadActivity/AddMember",
+            "priority": "Normal",
+            "version": "1593106976753",
+            "content": "<addmember><eventtime>1593106976753</eventtime><initiator>8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b</initiator><rosterVersion>1593106976566</rosterVersion><target>8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a</target><detailedtargetinfo><id>8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a</id></detailedtargetinfo><target>8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b</target><detailedtargetinfo><id>8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b</id></detailedtargetinfo><target>8:acs:29d8ac59-6011-44dc-87c0-1f9f93dbc713_2a711a-6c8ffcdc41</target><detailedtargetinfo><id>8:acs:29d8ac59-6011-44dc-87c0-1f9f93dbc713_2a711a-6c8ffcdc41</id></detailedtargetinfo><target>8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c</target><detailedtargetinfo><id>8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c</id></detailedtargetinfo></addmember>",
+            "createdOn": "2020-06-25T17:42:56.7530000Z",
+            "senderId": "19:[email protected]"
+          }
+        ],
+        "nextLink": "https://contoso.westus.communications.azure.com/chat/threads/19:[email protected]/messages?syncState=3e4700000031393a756e6930315f7a626e68336e74326466756666657a6333736f7837646f67377766686b36793571653272776c6e66686c68647a69726968647071407468726561642e763201451fe6e77201000004357fea72010000&startTime=0&$maxpagesize=5&api-version=2020-11-01-preview3"
+      }
+    },
+    "401": {
+      "body": {
+        "code": "Unauthorized",
+        "message": "Request is not authorized."
+      }
+    },
+    "403": {
+      "body": {
+        "code": "Forbidden",
+        "message": "User is not allowed to perform specified action."
+      }
+    },
+    "429": {
+      "body": {
+        "code": "TooManyRequests",
+        "message": "Rate limit exceeded."
+      }
+    },
+    "503": {
+      "body": {
+        "code": "ServiceUnavailable",
+        "message": "The server is currently unable to handle the request."
+      }
+    }
+  }
+}

specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_ListChatMessagesWithPageSize.json

@@ -0,0 +1,46 @@
+{
+  "parameters": {
+    "endpoint": "https://contoso.westus.communications.azure.com",
+    "api-version": "2020-11-01-preview3",
+    "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+    "sendChatMessageRequest": {
+      "priority": "Normal",
+      "content": "Let's head out for lunch in 15 minutes.",
+      "senderDisplayName": "Jane"
+    }
+  },
+  "responses": {
+    "201": {
+      "headers": {
+        "Location": "https://contoso.westus.communications.azure.com/chat/threads/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/messages/1593072104708"
+      },
+      "body": {
+        "id": "1593072104708"
+      }
+    },
+    "401": {
+      "body": {
+        "code": "Unauthorized",
+        "message": "Request is not authorized."
+      }
+    },
+    "403": {
+      "body": {
+        "code": "Forbidden",
+        "message": "User is not allowed to perform specified action."
+      }
+    },
+    "429": {
+      "body": {
+        "code": "TooManyRequests",
+        "message": "Rate limit exceeded."
+      }
+    },
+    "503": {
+      "body": {
+        "code": "ServiceUnavailable",
+        "message": "The server is currently unable to handle the request."
+      }
+    }
+  }
+}

specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_SendChatMessage.json

@@ -0,0 +1,35 @@
+{
+  "parameters": {
+    "x-skypetoken": "token",
+    "endpoint": "https://contoso.westus.communications.azure.com",
+    "api-version": "2020-11-01-preview3",
+    "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"
+  },
+  "responses": {
+    "200": {},
+    "401": {
+      "body": {
+        "code": "Unauthorized",
+        "message": "Request is not authorized."
+      }
+    },
+    "403": {
+      "body": {
+        "code": "Forbidden",
+        "message": "User is not allowed to perform specified action."
+      }
+    },
+    "429": {
+      "body": {
+        "code": "TooManyRequests",
+        "message": "Rate limit exceeded."
+      }
+    },
+    "503": {
+      "body": {
+        "code": "ServiceUnavailable",
+        "message": "The server is currently unable to handle the request."
+      }
+    }
+  }
+}

specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_SendTypingNotification.json

@@ -0,0 +1,39 @@
+{
+  "parameters": {
+    "endpoint": "https://contoso.westus.communications.azure.com",
+    "content-type": "application/merge-patch+json",
+    "api-version": "2020-11-01-preview3",
+    "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+    "chatMessageId": "1591768249318",
+    "updateChatMessageRequest": {
+      "content": "Updated message content"
+    }
+  },
+  "responses": {
+    "204": {},
+    "401": {
+      "body": {
+        "code": "Unauthorized",
+        "message": "Request is not authorized."
+      }
+    },
+    "403": {
+      "body": {
+        "code": "Forbidden",
+        "message": "User is not allowed to perform specified action."
+      }
+    },
+    "429": {
+      "body": {
+        "code": "TooManyRequests",
+        "message": "Rate limit exceeded."
+      }
+    },
+    "503": {
+      "body": {
+        "code": "ServiceUnavailable",
+        "message": "The server is currently unable to handle the request."
+      }
+    }
+  }
+}