diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json index dbf06d7ac34d..54d641e59c86 100644 --- a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json @@ -122,7 +122,7 @@ } ], "responses": { - "201": { + "200": { "description": "Request successful." }, "401": { @@ -680,16 +680,15 @@ "nextLinkName": "nextLink", "itemName": "value" } - }, - "post": { + } + }, + "/chat/threads/{chatThreadId}/participants/{chatParticipantId}": { + "delete": { "tags": [ "Participants" ], - "summary": "Adds thread participants to a thread. If participants already exist, no change occurs.", - "operationId": "ChatThread_AddChatParticipants", - "consumes": [ - "application/json" - ], + "summary": "Remove a participant from a thread.", + "operationId": "ChatThread_RemoveChatParticipant", "produces": [ "application/json" ], @@ -697,29 +696,24 @@ { "in": "path", "name": "chatThreadId", - "description": "Id of the thread to add participants to.", + "description": "Thread id to remove the participant from.", "required": true, "type": "string" }, { - "$ref": "#/parameters/ApiVersionParameter" + "in": "path", + "name": "chatParticipantId", + "description": "Id of the thread participant to remove from the thread.", + "required": true, + "type": "string" }, { - "in": "body", - "name": "addChatParticipantsRequest", - "description": "Thread participants to be added to the thread.", - "required": true, - "schema": { - "$ref": "#/definitions/AddChatParticipantsRequest" - } + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { - "201": { - "description": "The participants were successfully added.", - "schema": { - "$ref": "#/definitions/AddChatParticipantsResult" - } + "204": { + "description": "Request successful." }, "401": { "description": "Unauthorized.", @@ -751,19 +745,22 @@ } }, "x-ms-examples": { - "Add participants": { - "$ref": "./examples/Participants_AddChatParticipants.json" + "Remove participant": { + "$ref": "./examples/Participants_RemoveChatParticipant.json" } } } }, - "/chat/threads/{chatThreadId}/participants/{chatParticipantId}": { - "delete": { + "/chat/threads/{chatThreadId}/participants/:add": { + "post": { "tags": [ "Participants" ], - "summary": "Remove a participant from a thread.", - "operationId": "ChatThread_RemoveChatParticipant", + "summary": "Adds thread participants to a thread. If participants already exist, no change occurs.", + "operationId": "ChatThread_AddChatParticipants", + "consumes": [ + "application/json" + ], "produces": [ "application/json" ], @@ -771,24 +768,29 @@ { "in": "path", "name": "chatThreadId", - "description": "Thread id to remove the participant from.", + "description": "Id of the thread to add participants to.", "required": true, "type": "string" }, { - "in": "path", - "name": "chatParticipantId", - "description": "Id of the thread participant to remove from the thread.", - "required": true, - "type": "string" + "$ref": "#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "in": "body", + "name": "addChatParticipantsRequest", + "description": "Thread participants to be added to the thread.", + "required": true, + "schema": { + "$ref": "#/definitions/AddChatParticipantsRequest" + } } ], "responses": { - "204": { - "description": "Request successful." + "201": { + "description": "The participants were successfully added.", + "schema": { + "$ref": "#/definitions/AddChatParticipantsResult" + } }, "401": { "description": "Unauthorized.", @@ -820,8 +822,8 @@ } }, "x-ms-examples": { - "Remove participant": { - "$ref": "./examples/Participants_RemoveChatParticipant.json" + "Add participants": { + "$ref": "./examples/Participants_AddChatParticipants.json" } } } @@ -1268,8 +1270,8 @@ "ChatMessagePriority": { "description": "The chat message priority.", "enum": [ - "Normal", - "High" + "normal", + "high" ], "type": "string", "x-ms-enum": { @@ -1311,6 +1313,74 @@ } } }, + "ChatMessageType": { + "description": "The chat message type.", + "enum": [ + "text", + "html", + "topicUpdated", + "participantAdded", + "participantRemoved" + ], + "type": "string", + "x-ms-enum": { + "name": "ChatMessageType", + "modelAsString": true + } + }, + "ChatParticipant": { + "description": "A participant of the chat thread.", + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "description": "The id of the chat participant.", + "type": "string", + "example": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + }, + "displayName": { + "description": "Display name for the chat participant.", + "type": "string", + "example": "Bob" + }, + "shareHistoryTime": { + "format": "date-time", + "description": "Time from which the chat history is shared with the participant. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "example": "2020-10-30T10:50:50Z" + } + } + }, + "ChatMessageContent": { + "description": "Content of a chat message.", + "type": "object", + "properties": { + "message": { + "description": "Chat message content for type \"text\" or \"html\" messages.", + "type": "string", + "example": "Come one guys, lets go for lunch together." + }, + "topic": { + "description": "Chat message content for type \"topicUpdated\" messages.", + "type": "string", + "example": "Lunch Chat thread" + }, + "participants": { + "description": "Chat message content for type \"participantAdded\" or \"participantRemoved\" messages.", + "type": "array", + "items": { + "$ref": "#/definitions/ChatParticipant" + } + }, + "initiator": { + "description": "Chat message content for type \"participantAdded\" or \"participantRemoved\" messages.", + "type": "string", + "example": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + } + }, "ChatMessage": { "description": "Chat message.", "type": "object", @@ -1322,9 +1392,7 @@ "example": "123456789" }, "type": { - "description": "Type of the chat message.\r\n \r\nPossible values:\r\n - Text\r\n - ThreadActivity/TopicUpdate\r\n - ThreadActivity/AddMember\r\n - ThreadActivity/DeleteMember", - "type": "string", - "example": "Text" + "$ref": "#/definitions/ChatMessageType" }, "priority": { "$ref": "#/definitions/ChatMessagePriority" @@ -1335,9 +1403,7 @@ "readOnly": true }, "content": { - "description": "Content of the chat message.", - "type": "string", - "example": "Come one guys, lets go for lunch together." + "$ref": "#/definitions/ChatMessageContent" }, "senderDisplayName": { "description": "The display name of the chat message sender. This property is used to populate sender name for push notifications.", @@ -1404,31 +1470,6 @@ } } }, - "ChatParticipant": { - "description": "A participant of the chat thread.", - "required": [ - "id" - ], - "type": "object", - "properties": { - "id": { - "description": "The id of the chat participant.", - "type": "string", - "example": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" - }, - "displayName": { - "description": "Display name for the chat participant.", - "type": "string", - "example": "Bob" - }, - "shareHistoryTime": { - "format": "date-time", - "description": "Time from which the chat history is shared with the participant. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", - "type": "string", - "example": "2020-10-30T10:50:50Z" - } - } - }, "ChatParticipantsCollection": { "description": "Collection of participants belong to a particular thread.", "type": "object", diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Conversations_ListChatReadReceiptsWithPageSize.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Conversations_ListChatReadReceiptsWithPageSize.json index fc5df4ecc008..a1f3ecd32706 100644 --- a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Conversations_ListChatReadReceiptsWithPageSize.json +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Conversations_ListChatReadReceiptsWithPageSize.json @@ -3,7 +3,7 @@ "endpoint": "https://contoso.westus.communications.azure.com", "api-version": "2020-11-01-preview3", "chatThreadId": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", - "$maxpagesize": 2 + "maxPageSize": 2 }, "responses": { "200": { @@ -20,7 +20,7 @@ "readOn": "2020-06-06T05:55:41.6460000Z" } ], - "nextLink": "https://contoso.westus.communications.azure.com/chat/threads/19:453dafb77b26481ea2e73bcada0324af@thread.v2/readReceipts?skip=2&$maxpagesize=2&api-version=2020-11-01-preview3" + "nextLink": "https://contoso.westus.communications.azure.com/chat/threads/19:453dafb77b26481ea2e73bcada0324af@thread.v2/readReceipts?skip=2&maxPageSize=2&api-version=2020-11-01-preview3" } }, "401": { diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Conversations_SendChatReadReceipt.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Conversations_SendChatReadReceipt.json index 080f838cca60..584dd570160f 100644 --- a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Conversations_SendChatReadReceipt.json +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Conversations_SendChatReadReceipt.json @@ -8,7 +8,7 @@ } }, "responses": { - "201": {}, + "200": {}, "401": { "body": { "code": "Unauthorized", diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_GetChatMessage.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_GetChatMessage.json index ca7d28887a95..ff48b0bf0e18 100644 --- a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_GetChatMessage.json +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_GetChatMessage.json @@ -9,10 +9,12 @@ "200": { "body": { "id": "1591768249318", - "type": "Text", + "type": "text", "version": "1599016601134", - "priority": "Normal", - "content": "Let's head out for lunch in 15 minutes.", + "priority": "normal", + "content": { + "message": "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" diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_ListChatMessagesWithPageSize.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_ListChatMessagesWithPageSize.json index c825859167b9..4dda5c1bc6b9 100644 --- a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_ListChatMessagesWithPageSize.json +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_ListChatMessagesWithPageSize.json @@ -3,7 +3,7 @@ "endpoint": "https://contoso.westus.communications.azure.com", "api-version": "2020-11-01-preview3", "chatThreadId": "19:453dafb77b26481ea2e73bcada0324af@thread.v2", - "$maxpagesize": 5 + "maxPageSize": 5 }, "responses": { "200": { @@ -11,54 +11,79 @@ "value": [ { "id": "1593107077690", - "type": "Text", - "priority": "Normal", + "type": "text", + "priority": "normal", "version": "1593107077683", - "content": "So where should we get lunch from today?", + "content": + { + "message": "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", + "type": "text", + "priority": "normal", "version": "1593107077683", - "content": "Let's use this chat to decide what to get for lunch today.", + "content": + { + "message": "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", + "type": "text", + "priority": "normal", "version": "1593107046498", - "content": "Good morning everyone!", + "content": + { + "message": "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", + "type": "topicUpdated", + "priority": "normal", "version": "1593106976785", - "content": "15931069767858:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10bLunch", - "createdOn": "2020-06-25T17:42:56.7850000Z", - "senderId": "19:453dafb77b26481ea2e73bcada0324af@thread.v2" + "content": + { + "initiator": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "topic": "Lunch" + }, + "createdOn": "2020-06-25T17:42:56.7850000Z" }, { "id": "1593106976753", - "type": "ThreadActivity/AddMember", - "priority": "Normal", + "type": "participantAdded", + "priority": "normal", "version": "1593106976753", - "content": "15931069767538:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b15931069765668:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b8:acs:29d8ac59-6011-44dc-87c0-1f9f93dbc713_2a711a-6c8ffcdc418:acs:29d8ac59-6011-44dc-87c0-1f9f93dbc713_2a711a-6c8ffcdc418:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c", - "createdOn": "2020-06-25T17:42:56.7530000Z", - "senderId": "19:453dafb77b26481ea2e73bcada0324af@thread.v2" + "content": + { + "initiator": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", + "participants": [ + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c" + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10d" + } + ] + }, + "createdOn": "2020-06-25T17:42:56.7530000Z" } ], - "nextLink": "https://contoso.westus.communications.azure.com/chat/threads/19:453dafb77b26481ea2e73bcada0324af@thread.v2/messages?syncState=3e4700000031393a756e6930315f7a626e68336e74326466756666657a6333736f7837646f67377766686b36793571653272776c6e66686c68647a69726968647071407468726561642e763201451fe6e77201000004357fea72010000&startTime=0&$maxpagesize=5&api-version=2020-11-01-preview3" + "nextLink": "https://contoso.westus.communications.azure.com/chat/threads/19:453dafb77b26481ea2e73bcada0324af@thread.v2/messages?syncState=3e4700000031393a756e6930315f7a626e68336e74326466756666657a6333736f7837646f67377766686b36793571653272776c6e66686c68647a69726968647071407468726561642e763201451fe6e77201000004357fea72010000&startTime=0&maxPageSize=5&api-version=2020-11-01-preview3" } }, "401": { diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_SendChatMessage.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_SendChatMessage.json index cf54f781ca1e..7a5223519b51 100644 --- a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_SendChatMessage.json +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_SendChatMessage.json @@ -4,7 +4,7 @@ "api-version": "2020-11-01-preview3", "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "sendChatMessageRequest": { - "priority": "Normal", + "priority": "normal", "content": "Let's head out for lunch in 15 minutes.", "senderDisplayName": "Jane" } diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_ListChatParticipantsWithPageSize.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_ListChatParticipantsWithPageSize.json index c4d504569065..4f81d77fed8c 100644 --- a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_ListChatParticipantsWithPageSize.json +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_ListChatParticipantsWithPageSize.json @@ -3,7 +3,7 @@ "endpoint": "https://contoso.westus.communications.azure.com", "api-version": "2020-11-01-preview3", "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2", - "$maxpagesize": 2 + "maxPageSize": 2 }, "responses": { "200": { @@ -20,7 +20,7 @@ "shareHistoryTime": "2020-06-06T05:55:41Z" } ], - "nextLink": "https://contoso.westus.communications.azure.com/chat/threads/19:453dafb77b26481ea2e73bcada0324af@thread.v2/participants?skip=2&$maxpagesize=2&api-version=2020-11-01-preview3" + "nextLink": "https://contoso.westus.communications.azure.com/chat/threads/19:453dafb77b26481ea2e73bcada0324af@thread.v2/participants?skip=2&maxPageSize=2&api-version=2020-11-01-preview3" } }, "401": { diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_ListChatThreadsWithPageSize.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_ListChatThreadsWithPageSize.json index 661b9f1d5923..a23b589e5523 100644 --- a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_ListChatThreadsWithPageSize.json +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_ListChatThreadsWithPageSize.json @@ -2,7 +2,7 @@ "parameters": { "endpoint": "https://contoso.westus.communications.azure.com", "api-version": "2020-11-01-preview3", - "$maxpagesize": 5 + "maxPageSize": 5 }, "responses": { "200": { @@ -35,7 +35,7 @@ "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" } ], - "nextLink": "https://contoso.westus.communications.azure.com/chat/threads?syncState=W3sic3RhcnQiOiIyMDIwLTA2LTIzVDIzOjMyOjQ3LjMwNSswMDowMCIsImVuZCI6IjIwMjAtMDYtMjVUMDY6NTY6MjMuNjk2KzAwOjAwIn0seyJzdGFydCI6IjE5NzAtMDEtMDFUMDA6MDA6MDArMDA6MDAiLCJlbmQiOiIxOTcwLTAxLTAxVDAwOjAwOjAwKzAwOjAwIn1d&api-version=2020-11-01-preview3&$maxpagesize=5" + "nextLink": "https://contoso.westus.communications.azure.com/chat/threads?syncState=W3sic3RhcnQiOiIyMDIwLTA2LTIzVDIzOjMyOjQ3LjMwNSswMDowMCIsImVuZCI6IjIwMjAtMDYtMjVUMDY6NTY6MjMuNjk2KzAwOjAwIn0seyJzdGFydCI6IjE5NzAtMDEtMDFUMDA6MDA6MDArMDA6MDAiLCJlbmQiOiIxOTcwLTAxLTAxVDAwOjAwOjAwKzAwOjAwIn1d&api-version=2020-11-01-preview3&maxPageSize=5" } }, "401": {