From f832cfc33fbd8b2333580b2979585ccfbc6d5992 Mon Sep 17 00:00:00 2001 From: Camilo Ramirez Date: Tue, 17 Nov 2020 20:14:47 -0800 Subject: [PATCH 1/8] Added new specification for chat - release 2020-11-01-preview3 --- .../communicationserviceschat.json | 1589 +++++++++++++++++ .../Conversations_ListChatReadReceipts.json | 49 + .../Conversations_SendChatReadReceipt.json | 37 + .../examples/Messages_DeleteChatMessage.json | 35 + .../examples/Messages_GetChatMessage.json | 46 + ...Messages_ListChatMessagesWithPageSize.json | 88 + .../examples/Messages_SendChatMessage.json | 46 + .../Messages_SendTypingNotification.json | 35 + .../examples/Messages_UpdateChatMessage.json | 39 + .../Participants_AddChatParticipants.json | 56 + .../Participants_ListChatParticipants.json | 49 + .../Participants_RemoveChatParticipant.json | 35 + .../examples/Threads_CreateChatThread.json | 73 + .../examples/Threads_DeleteChatThread.json | 34 + .../examples/Threads_GetChatThread.json | 50 + .../Threads_ListChatThreadsWithPageSize.json | 65 + .../Threads_UpdateChatThreadTopic.json | 38 + .../communication/data-plane/readme.md | 11 + 18 files changed, 2375 insertions(+) create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Conversations_ListChatReadReceipts.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Conversations_SendChatReadReceipt.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_DeleteChatMessage.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_GetChatMessage.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_ListChatMessagesWithPageSize.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_SendChatMessage.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_SendTypingNotification.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_UpdateChatMessage.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_AddChatParticipants.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_ListChatParticipants.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_RemoveChatParticipant.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_CreateChatThread.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_DeleteChatThread.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_GetChatThread.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_ListChatThreadsWithPageSize.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_UpdateChatThreadTopic.json 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 new file mode 100644 index 000000000000..c0f1445dfadf --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json @@ -0,0 +1,1589 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Communication Chat Service", + "description": "Azure Communication Chat Service", + "contact": { + "email": "acsdevexdisc@microsoft.com" + }, + "version": "2020-11-01-preview3" + }, + "paths": { + "/chat/threads/{chatThreadId}/readreceipts": { + "get": { + "tags": [ + "Threads" + ], + "summary": "Gets chat message read receipts for a thread.", + "operationId": "ListChatReadReceipts", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "Thread id to get the chat message read receipts for.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The action returns the requested `ChatMessageReadReceipt` resources.", + "schema": { + "$ref": "#/definitions/ChatMessageReadReceiptsCollection" + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get thread read receipts": { + "$ref": "./examples/Conversations_ListChatReadReceipts.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + }, + "post": { + "tags": [ + "Threads" + ], + "summary": "Sends a read receipt event to a thread, on behalf of a user.", + "operationId": "SendChatReadReceipt", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "Thread id to send the read receipt event to.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "sendReadReceiptRequest", + "description": "Read receipt details.", + "required": true, + "schema": { + "$ref": "#/definitions/SendReadReceiptRequest" + } + } + ], + "responses": { + "201": { + "description": "Request successful." + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Send read receipt": { + "$ref": "./examples/Conversations_SendChatReadReceipt.json" + } + } + } + }, + "/chat/threads/{chatThreadId}/messages": { + "post": { + "tags": [ + "Messages" + ], + "summary": "Sends a message to a thread.", + "operationId": "SendChatMessage", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "The thread id to send the message to.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "sendChatMessageRequest", + "description": "Details of the message to send.", + "required": true, + "schema": { + "$ref": "#/definitions/SendChatMessageRequest" + } + } + ], + "responses": { + "201": { + "description": "Message sent, the `Location` header contains the URL for the newly sent message.", + "schema": { + "$ref": "#/definitions/SendChatMessageResult" + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Send Message": { + "$ref": "./examples/Messages_SendChatMessage.json" + } + } + }, + "get": { + "tags": [ + "Messages" + ], + "summary": "Gets a list of messages from a thread.", + "operationId": "ListChatMessages", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "The thread id of the message.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "The maximum number of messages to be returned per page.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "startTime", + "description": "The earliest point in time to get messages up to. The timestamp should be in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "format": "date-time" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ChatMessagesCollection" + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get messages with pagination (max page size)": { + "$ref": "./examples/Messages_ListChatMessagesWithPageSize.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/chat/threads/{chatThreadId}/messages/{chatMessageId}": { + "get": { + "tags": [ + "Messages" + ], + "summary": "Gets a message by id.", + "operationId": "GetChatMessage", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "The thread id to which the message was sent.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "chatMessageId", + "description": "The message id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The action returns a `Message` resource.", + "schema": { + "$ref": "#/definitions/ChatMessage" + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get Message": { + "$ref": "./examples/Messages_GetChatMessage.json" + } + } + }, + "patch": { + "tags": [ + "Messages" + ], + "summary": "Updates a message.", + "operationId": "UpdateChatMessage", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "The thread id to which the message was sent.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "chatMessageId", + "description": "The message id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "updateChatMessageRequest", + "description": "Details of the request to update the message.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateChatMessageRequest" + } + } + ], + "responses": { + "204": { + "description": "Message is successfully updated." + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Update message content": { + "$ref": "./examples/Messages_UpdateChatMessage.json" + } + } + }, + "delete": { + "tags": [ + "Messages" + ], + "summary": "Deletes a message.", + "operationId": "DeleteChatMessage", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "The thread id to which the message was sent.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "chatMessageId", + "description": "The message id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Request successful." + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Delete message": { + "$ref": "./examples/Messages_DeleteChatMessage.json" + } + } + } + }, + "/chat/threads/{chatThreadId}/typing": { + "post": { + "tags": [ + "Messages" + ], + "summary": "Posts a typing event to a thread, on behalf of a user.", + "operationId": "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/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/Error" + }, + "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": [ + "Participants" + ], + "summary": "Gets the participants of a thread.", + "operationId": "ListChatParticipants", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "Thread id to get participants for.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The action returns the participants of a thread.", + "schema": { + "$ref": "#/definitions/ChatParticipantsCollection" + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get participants": { + "$ref": "./examples/Participants_ListChatParticipants.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + }, + "post": { + "tags": [ + "Participants" + ], + "summary": "Adds thread participants to a thread. If participants already exist, no change occurs.", + "operationId": "AddChatParticipants", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "Id of the thread to add participants to.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "addChatParticipantsRequest", + "description": "Thread participants to be added to the thread.", + "required": true, + "schema": { + "$ref": "#/definitions/AddChatParticipantsRequest" + } + } + ], + "responses": { + "201": { + "description": "The participants were successfully added." + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Add participants": { + "$ref": "./examples/Participants_AddChatParticipants.json" + } + } + } + }, + "/chat/threads/{chatThreadId}/participants/{chatParticipantId}": { + "delete": { + "tags": [ + "Participants" + ], + "summary": "Remove a participant from a thread.", + "operationId": "RemoveChatParticipant", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "Thread id to remove the participant from.", + "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" + } + ], + "responses": { + "204": { + "description": "Request successful." + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Remove participant": { + "$ref": "./examples/Participants_RemoveChatParticipant.json" + } + } + } + }, + "/chat/threads": { + "post": { + "tags": [ + "Threads" + ], + "summary": "Creates a chat thread.", + "operationId": "CreateChatThread", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "createChatThreadRequest", + "description": "Request payload for creating a chat thread.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateChatThreadRequest" + } + } + ], + "responses": { + "201": { + "description": "Thread created, the `Location` header would contain the URL for the newly created thread.", + "schema": { + "$ref": "#/definitions/ChatThread" + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Create chat thread": { + "$ref": "./examples/Threads_CreateChatThread.json" + } + } + }, + "get": { + "tags": [ + "Threads" + ], + "summary": "Gets the list of chat threads of a user.", + "operationId": "ListChatThreads", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "maxPageSize", + "description": "The maximum number of chat threads returned per page.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "startTime", + "description": "The earliest point in time to get chat threads up to. The timestamp should be in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "format": "date-time" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The action returns a `GetThreadsResponse` resource.", + "schema": { + "$ref": "#/definitions/ChatThreadsInfoCollection" + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get threads with pagination (Max Page Size)": { + "$ref": "./examples/Threads_ListChatThreadsWithPageSize.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/chat/threads/{chatThreadId}": { + "patch": { + "tags": [ + "Threads" + ], + "summary": "Updates a thread's properties.", + "operationId": "UpdateChatThread", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "The id of the thread to update.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "updateChatThreadRequest", + "description": "Request payload for updating a chat thread.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateChatThreadRequest" + } + } + ], + "responses": { + "204": { + "description": "Thread was successfully updated." + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Update chat thread topic": { + "$ref": "./examples/Threads_UpdateChatThreadTopic.json" + } + } + }, + "get": { + "tags": [ + "Threads" + ], + "summary": "Gets a chat thread.", + "operationId": "GetChatThread", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "Thread id to get.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The action returns a `Thread` resource.", + "schema": { + "$ref": "#/definitions/ChatThread" + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get chat thread": { + "$ref": "./examples/Threads_GetChatThread.json" + } + } + }, + "delete": { + "tags": [ + "Threads" + ], + "summary": "Deletes a thread.", + "operationId": "DeleteChatThread", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "Thread id to delete.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Request successful." + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Delete chat thread": { + "$ref": "./examples/Threads_DeleteChatThread.json" + } + } + } + } + }, + "definitions": { + "ChatMessageReadReceipt": { + "description": "A chat message read receipt indicates the time a chat message was read by a recipient.", + "type": "object", + "properties": { + "senderId": { + "description": "Chat message read receipt sender id.", + "type": "string", + "readOnly": true, + "example": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + }, + "chatMessageId": { + "description": "Id for the chat message that has been read. This id is generated by the server.", + "type": "string", + "readOnly": true, + "example": "1591137790240" + }, + "readOn": { + "format": "date-time", + "description": "Chat message read receipt timestamp. The timestamp is in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "readOnly": true, + "example": "2020-10-30T10:50:50Z" + } + } + }, + "ChatMessageReadReceiptsCollection": { + "type": "object", + "properties": { + "value": { + "description": "Collection of chat message read receipts.", + "type": "array", + "items": { + "$ref": "#/definitions/ChatMessageReadReceipt" + }, + "readOnly": true + }, + "nextLink": { + "description": "If there are more chat message read receipts that can be retrieved, the next link will be populated.", + "type": "string", + "readOnly": true + } + } + }, + "Error": { + "type": "object", + "properties": { + "code": { + "description": "Error code", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Description of the error", + "type": "string", + "readOnly": true + }, + "target": { + "description": "If applicable, would be used to indicate the property causing the error", + "type": "string", + "readOnly": true + }, + "innerErrors": { + "description": "If applicable, inner errors would be returned for more details on the error", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + }, + "readOnly": true + } + } + }, + "SendReadReceiptRequest": { + "description": "Request payload for sending a read receipt.", + "required": [ + "chatMessageId" + ], + "type": "object", + "properties": { + "chatMessageId": { + "description": "Id of the latest chat message read by the user.", + "type": "string", + "example": "1592435762364" + } + } + }, + "ChatMessagePriority": { + "description": "The chat message priority.", + "enum": [ + "Normal", + "High" + ], + "type": "string", + "x-ms-enum": { + "name": "ChatMessagePriority", + "modelAsString": true + } + }, + "SendChatMessageRequest": { + "description": "Details of the message to send.", + "required": [ + "content" + ], + "type": "object", + "properties": { + "priority": { + "$ref": "#/definitions/ChatMessagePriority" + }, + "content": { + "description": "Chat message content.", + "type": "string", + "example": "Come one guys, lets go for lunch together." + }, + "senderDisplayName": { + "description": "The display name of the chat message sender. This property is used to populate sender name for push notifications.", + "type": "string", + "example": "Bob Admin" + } + } + }, + "SendChatMessageResult": { + "description": "Result of the send message operation.", + "type": "object", + "properties": { + "id": { + "description": "A server-generated message id.", + "type": "string", + "readOnly": true, + "example": "123456789" + } + } + }, + "ChatMessage": { + "type": "object", + "properties": { + "id": { + "description": "The id of the chat message. This id is server generated.", + "type": "string", + "readOnly": true, + "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" + }, + "priority": { + "$ref": "#/definitions/ChatMessagePriority" + }, + "version": { + "description": "Version of the chat message.", + "type": "string", + "readOnly": true + }, + "content": { + "description": "Content of the chat message.", + "type": "string", + "example": "Come one guys, lets go for lunch together." + }, + "senderDisplayName": { + "description": "The display name of the chat message sender. This property is used to populate sender name for push notifications.", + "type": "string", + "example": "Jane" + }, + "createdOn": { + "format": "date-time", + "description": "The timestamp when the chat message arrived at the server. The timestamp is in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "readOnly": true, + "example": "2020-10-30T10:50:50Z" + }, + "senderId": { + "description": "The id of the chat message sender.", + "type": "string", + "readOnly": true, + "example": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + }, + "deletedOn": { + "format": "date-time", + "description": "The timestamp when the chat message was deleted. The timestamp is in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "example": "2020-10-30T10:50:50Z" + }, + "editedOn": { + "format": "date-time", + "description": "The timestamp when the chat message was edited. The timestamp is in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "example": "2020-10-30T10:50:50Z" + } + } + }, + "ChatMessagesCollection": { + "description": "Collection of chat messages for a particular chat thread.", + "type": "object", + "properties": { + "value": { + "description": "Collection of chat messages.", + "type": "array", + "items": { + "$ref": "#/definitions/ChatMessage" + }, + "readOnly": true + }, + "nextLink": { + "description": "If there are more chat messages that can be retrieved, the next link will be populated.", + "type": "string", + "readOnly": true + } + } + }, + "UpdateChatMessageRequest": { + "type": "object", + "properties": { + "content": { + "description": "Chat message content.", + "type": "string", + "example": "Let's go for lunch together." + }, + "priority": { + "$ref": "#/definitions/ChatMessagePriority" + } + } + }, + "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 ISO8601 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", + "properties": { + "value": { + "description": "Chat participants.", + "type": "array", + "items": { + "$ref": "#/definitions/ChatParticipant" + } + }, + "nextLink": { + "description": "If there are more chat participants that can be retrieved, the next link will be populated.", + "type": "string", + "readOnly": true + } + } + }, + "AddChatParticipantsRequest": { + "description": "Participants to be added to the thread.", + "required": [ + "participants" + ], + "type": "object", + "properties": { + "participants": { + "description": "Participants to add to a chat thread.", + "type": "array", + "items": { + "$ref": "#/definitions/ChatParticipant" + } + } + } + }, + "CreateChatThreadRequest": { + "description": "Request payload for creating a chat thread.", + "required": [ + "participants", + "topic" + ], + "type": "object", + "properties": { + "topic": { + "description": "The chat thread topic.", + "type": "string", + "example": "Lunch Thread" + }, + "participants": { + "description": "Participants to be added to the chat thread.", + "type": "array", + "items": { + "$ref": "#/definitions/ChatParticipant" + } + } + } + }, + "ChatThread": { + "type": "object", + "properties": { + "id": { + "description": "Chat thread id.", + "type": "string", + "readOnly": true, + "example": "19:uni01_uy5ucb66ugp3lrhe7pxso6xx4hsmm3dl6eyjfefv2n6x3rrurpea@thread.v2" + }, + "topic": { + "description": "Chat thread topic.", + "type": "string", + "example": "Lunch Chat thread" + }, + "createdOn": { + "format": "date-time", + "description": "The timestamp when the chat thread was created. The timestamp is in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "readOnly": true, + "example": "2020-10-30T10:50:50Z" + }, + "createdBy": { + "description": "Id of the chat thread owner.", + "type": "string", + "readOnly": true, + "example": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + }, + "deletedOn": { + "format": "date-time", + "description": "The timestamp when the chat thread was deleted. The timestamp is in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "example": "2020-10-30T10:50:50Z" + }, + "participants": { + "description": "Chat participants.", + "type": "array", + "items": { + "$ref": "#/definitions/ChatParticipant" + } + } + } + }, + "ChatThreadInfo": { + "type": "object", + "properties": { + "id": { + "description": "Chat thread id.", + "type": "string", + "readOnly": true, + "example": "19:uni01_uy5ucb66ugp3lrhe7pxso6xx4hsmm3dl6eyjfefv2n6x3rrurpea@thread.v2" + }, + "topic": { + "description": "Chat thread topic.", + "type": "string", + "example": "Lunch Chat thread" + }, + "deletedOn": { + "format": "date-time", + "description": "The timestamp when the chat thread was deleted. The timestamp is in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "example": "2020-10-30T10:50:50Z" + }, + "lastMessageReceivedOn": { + "format": "date-time", + "description": "The timestamp when the last message arrived at the server. The timestamp is in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "readOnly": true, + "example": "2020-10-30T10:50:50Z" + } + } + }, + "ChatThreadsInfoCollection": { + "description": "Collection of chat threads.", + "type": "object", + "properties": { + "value": { + "description": "Collection of chat threads.", + "type": "array", + "items": { + "$ref": "#/definitions/ChatThreadInfo" + }, + "readOnly": true + }, + "nextLink": { + "description": "If there are more chat threads that can be retrieved, the next link will be populated.", + "type": "string", + "readOnly": true + } + } + }, + "UpdateChatThreadRequest": { + "type": "object", + "properties": { + "topic": { + "description": "Chat thread topic.", + "type": "string", + "example": "Lunch Thread" + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "in": "query", + "name": "api-version", + "description": "Version of API to invoke.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "Endpoint": { + "in": "path", + "name": "endpoint", + "description": "The endpoint of the Azure Communication resource.", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + } + }, + "securityDefinitions": { + "Authorization": { + "type": "apiKey", + "name": "Authorization", + "in": "header", + "description": "An ACS (Azure Communication Services) user access token." + } + }, + "security": [ + { + "Authorization": [ ] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + } +} \ No newline at end of file diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Conversations_ListChatReadReceipts.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Conversations_ListChatReadReceipts.json new file mode 100644 index 000000000000..90244c69e007 --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Conversations_ListChatReadReceipts.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-11-01-preview3", + "chatThreadId": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2" + }, + "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": null + } + }, + "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." + } + } + } +} \ No newline at end of file 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 new file mode 100644 index 000000000000..e902be463679 --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Conversations_SendChatReadReceipt.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." + } + } + } +} \ No newline at end of file diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_DeleteChatMessage.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_DeleteChatMessage.json new file mode 100644 index 000000000000..69c1220e4f43 --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_DeleteChatMessage.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." + } + } + } +} \ No newline at end of file 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 new file mode 100644 index 000000000000..fa744d68d00c --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_GetChatMessage.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." + } + } + } +} \ No newline at end of file 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 new file mode 100644 index 000000000000..965f3e6284d0 --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_ListChatMessagesWithPageSize.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-11-01-preview3", + "chatThreadId": "19:453dafb77b26481ea2e73bcada0324af@thread.v2", + "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": "15931069767858:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10bLunch", + "createdOn": "2020-06-25T17:42:56.7850000Z", + "senderId": "19:453dafb77b26481ea2e73bcada0324af@thread.v2" + }, + { + "id": "1593106976753", + "type": "ThreadActivity/AddMember", + "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" + } + ], + "nextLink": "https://contoso.westus.communications.azure.com/chat/threads/19:453dafb77b26481ea2e73bcada0324af@thread.v2/messages?syncState=3e4700000031393a756e6930315f7a626e68336e74326466756666657a6333736f7837646f67377766686b36793571653272776c6e66686c68647a69726968647071407468726561642e763201451fe6e77201000004357fea72010000&startTime=0&maxPageSize=5&api-version=2020-09-21-preview2" + } + }, + "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." + } + } + } +} \ No newline at end of file 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 new file mode 100644 index 000000000000..4189f17c4363 --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_SendChatMessage.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." + } + } + } +} \ No newline at end of file diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_SendTypingNotification.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_SendTypingNotification.json new file mode 100644 index 000000000000..927bcf57276b --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_SendTypingNotification.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." + } + } + } +} \ No newline at end of file diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_UpdateChatMessage.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_UpdateChatMessage.json new file mode 100644 index 000000000000..5fce4a4cded9 --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_UpdateChatMessage.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." + } + } + } +} \ No newline at end of file diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_AddChatParticipants.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_AddChatParticipants.json new file mode 100644 index 000000000000..2804cc233ee4 --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_AddChatParticipants.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-11-01-preview3", + "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2", + "addChatParticipantsRequest": { + "participants": [{ + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "displayName": "Alex", + "shareHistoryTime": "2020-06-06T05:55:41Z" + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", + "displayName": "Peter", + "shareHistoryTime": "2020-06-06T05:55:41Z" + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c", + "displayName": "Rama", + "shareHistoryTime": "2020-06-06T05:55:41Z" + } + ] + } + }, + "responses": { + "201": { + "headers": { + "Azure-Acs-InvalidParticipants": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c,403|8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a,404" + } + }, + "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." + } + } + } +} \ No newline at end of file diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_ListChatParticipants.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_ListChatParticipants.json new file mode 100644 index 000000000000..8486c612548e --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_ListChatParticipants.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-11-01-preview3", + "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", + "displayName": "Jane", + "shareHistoryTime": "2020-06-06T05:55:41Z" + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "displayName": "Alex", + "shareHistoryTime": "2020-06-06T05:55:41Z" + } + ], + "nextLink": null + } + }, + "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." + } + } + } +} \ No newline at end of file diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_RemoveChatParticipant.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_RemoveChatParticipant.json new file mode 100644 index 000000000000..1942b3a8c1a1 --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_RemoveChatParticipant.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-11-01-preview3", + "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2", + "chatParticipantId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a" + }, + "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." + } + } + } +} \ No newline at end of file diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_CreateChatThread.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_CreateChatThread.json new file mode 100644 index 000000000000..708aa6f015fe --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_CreateChatThread.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-11-01-preview3", + "createChatThreadRequest": { + "topic": "Lunch", + "participants": [{ + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", + "displayName": "Jane" + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "displayName": "Alex" + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c", + "displayName": "Bob" + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10d", + "displayName": "Peter" + } + ] + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://contoso.westus.communications.azure.com/chat/threads/19%3Auni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", + "Azure-Acs-InvalidParticipants": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c,403|8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10d,404" + }, + "body": { + "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", + "topic": "Lunch", + "createdOn": "2020-06-06T05:55:41.6460000Z", + "createdBy": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "participants": [{ + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", + "shareHistoryTime": "2020-06-06T05:55:41Z" + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "shareHistoryTime": "2020-06-06T05:55:41Z" + } + ] + } + }, + "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." + } + } + } +} \ No newline at end of file diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_DeleteChatThread.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_DeleteChatThread.json new file mode 100644 index 000000000000..01e49e5f76a5 --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_DeleteChatThread.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-11-01-preview3", + "chatThreadId": "19:9525281ac1f947fc884bcee1a9f983c2@thread.v2" + }, + "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." + } + } + } +} \ No newline at end of file diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_GetChatThread.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_GetChatThread.json new file mode 100644 index 000000000000..c89bb0e4509a --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_GetChatThread.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-11-01-preview3", + "chatThreadId": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2" + }, + "responses": { + "200": { + "body": { + "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", + "topic": "Lunch", + "createdOn": "2020-06-06T05:55:41.6460000Z", + "createdBy": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "participants": [{ + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", + "shareHistoryTime": "2020-06-06T05:55:41Z" + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "shareHistoryTime": "2020-06-06T05:55:41Z" + } + ] + } + }, + "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." + } + } + } +} \ No newline at end of file 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 new file mode 100644 index 000000000000..9066307a4a55 --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_ListChatThreadsWithPageSize.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-11-01-preview3", + "maxmaxPageSize": 5 + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", + "topic": "Chat with Samantha", + "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" + }, + { + "id": "19:a0dfe5fc10e04a7f8d8a64d455f4196d@thread.v2", + "topic": "Presentation Brainstorming", + "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" + }, + { + "id": "19:uni01_n242d2bzammtwxiib7pbjtozeevjqzavzn654ku3dajocexfo2na@thread.v2", + "topic": "Chat with Alex", + "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" + }, + { + "id": "19:0062022a28be4e0983734f7e45cd8566@thread.v2", + "topic": "Lunch", + "deletedOn": "2020-07-07T05:55:41.6460000Z", + "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" + }, + { + "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpe@thread.v2", + "topic": "Chat with Bob", + "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" + } + ], + "nextLink": "https://contoso.westus.communications.azure.com/chat/threads?syncState=W3sic3RhcnQiOiIyMDIwLTA2LTIzVDIzOjMyOjQ3LjMwNSswMDowMCIsImVuZCI6IjIwMjAtMDYtMjVUMDY6NTY6MjMuNjk2KzAwOjAwIn0seyJzdGFydCI6IjE5NzAtMDEtMDFUMDA6MDA6MDArMDA6MDAiLCJlbmQiOiIxOTcwLTAxLTAxVDAwOjAwOjAwKzAwOjAwIn1d&api-version=2020-09-21-preview2&maxmaxPageSize=5" + } + }, + "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." + } + } + } +} \ No newline at end of file diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_UpdateChatThreadTopic.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_UpdateChatThreadTopic.json new file mode 100644 index 000000000000..22e91473034e --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_UpdateChatThreadTopic.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "content-type": "application/merge-patch+json", + "api-version": "2020-11-01-preview3", + "chatThreadId": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", + "updateChatThreadRequest": { + "topic": "Updated Thread Topic" + } + }, + "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." + } + } + } +} \ No newline at end of file diff --git a/specification/communication/data-plane/readme.md b/specification/communication/data-plane/readme.md index 32387d6d037d..34e21ad1c2ae 100644 --- a/specification/communication/data-plane/readme.md +++ b/specification/communication/data-plane/readme.md @@ -57,6 +57,17 @@ title: Azure Communication Services ``` +### Tag: package-2020-11-01-preview3 + +These settings apply only when `--tag=package-2020-11-01-preview3` is specified on the command line. + +```yaml $(tag) == 'package-2020-11-01-preview3' +input-file: + - Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json +title: + Azure Communication Services +``` + ### Tag: package-2020-07-20-preview2 These settings apply only when `--tag=package-2020-07-20-preview2` is specified on the command line. From 57f25708b93c401cdddf8787af39971e5913a2b1 Mon Sep 17 00:00:00 2001 From: Amr Elroumy Date: Mon, 30 Nov 2020 22:55:07 -0800 Subject: [PATCH 2/8] Addressing feedback --- .../communicationserviceschat.json | 289 +++++++++++------- ...ions_ListChatReadReceiptsWithPageSize.json | 50 +++ ...Messages_ListChatMessagesWithPageSize.json | 2 +- .../Participants_AddChatParticipants.json | 16 +- ...ants_ListChatParticipantsWithPageSize.json | 50 +++ .../ThreadMembers_AddChatThreadMembers.json | 67 ++++ .../ThreadMembers_ListChatThreadMembers.json | 49 +++ .../ThreadMembers_RemoveChatThreadMember.json | 35 +++ .../examples/Threads_CreateChatThread.json | 35 ++- ...eChatThreadWithRepeatabilityRequestId.json | 79 +++++ .../examples/Threads_GetChatThread.json | 11 +- .../Threads_ListChatThreadsWithPageSize.json | 2 +- 12 files changed, 549 insertions(+), 136 deletions(-) create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Conversations_ListChatReadReceiptsWithPageSize.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_ListChatParticipantsWithPageSize.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_AddChatThreadMembers.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_ListChatThreadMembers.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_RemoveChatThreadMember.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_CreateChatThreadWithRepeatabilityRequestId.json 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 c0f1445dfadf..147fb5aa3779 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 @@ -3,19 +3,16 @@ "info": { "title": "Azure Communication Chat Service", "description": "Azure Communication Chat Service", - "contact": { - "email": "acsdevexdisc@microsoft.com" - }, "version": "2020-11-01-preview3" }, "paths": { - "/chat/threads/{chatThreadId}/readreceipts": { + "/chat/threads/{chatThreadId}/readReceipts": { "get": { "tags": [ "Threads" ], "summary": "Gets chat message read receipts for a thread.", - "operationId": "ListChatReadReceipts", + "operationId": "ChatThread_ListChatReadReceipts", "produces": [ "application/json" ], @@ -27,6 +24,20 @@ "required": true, "type": "string" }, + { + "in": "query", + "name": "maxPageSize", + "description": "The maximum number of chat message read receipts to be returned per page.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "skip", + "description": "Skips chat message read receipts up to a specified position in response.", + "type": "integer", + "format": "int32" + }, { "$ref": "#/parameters/ApiVersionParameter" } @@ -39,28 +50,28 @@ } }, "401": { - "description": "Unauthorized", + "description": "Unauthorized.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "403": { - "description": "Forbidden", + "description": "Forbidden.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "429": { - "description": "Too many requests", + "description": "Too many requests.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "503": { - "description": "Service unavailable", + "description": "Service unavailable.", "schema": { "$ref": "#/definitions/Error" }, @@ -68,8 +79,8 @@ } }, "x-ms-examples": { - "Get thread read receipts": { - "$ref": "./examples/Conversations_ListChatReadReceipts.json" + "Get thread read receipts with pagination (max page size)": { + "$ref": "./examples/Conversations_ListChatReadReceiptsWithPageSize.json" } }, "x-ms-pageable": { @@ -82,7 +93,7 @@ "Threads" ], "summary": "Sends a read receipt event to a thread, on behalf of a user.", - "operationId": "SendChatReadReceipt", + "operationId": "ChatThread_SendChatReadReceipt", "consumes": [ "application/json" ], @@ -115,28 +126,28 @@ "description": "Request successful." }, "401": { - "description": "Unauthorized", + "description": "Unauthorized.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "403": { - "description": "Forbidden", + "description": "Forbidden.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "429": { - "description": "Too many requests", + "description": "Too many requests.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "503": { - "description": "Service unavailable", + "description": "Service unavailable.", "schema": { "$ref": "#/definitions/Error" }, @@ -156,7 +167,7 @@ "Messages" ], "summary": "Sends a message to a thread.", - "operationId": "SendChatMessage", + "operationId": "ChatThread_SendChatMessage", "consumes": [ "application/json" ], @@ -192,28 +203,28 @@ } }, "401": { - "description": "Unauthorized", + "description": "Unauthorized.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "403": { - "description": "Forbidden", + "description": "Forbidden.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "429": { - "description": "Too many requests", + "description": "Too many requests.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "503": { - "description": "Service unavailable", + "description": "Service unavailable.", "schema": { "$ref": "#/definitions/Error" }, @@ -231,7 +242,7 @@ "Messages" ], "summary": "Gets a list of messages from a thread.", - "operationId": "ListChatMessages", + "operationId": "ChatThread_ListChatMessages", "produces": [ "application/json" ], @@ -269,28 +280,28 @@ } }, "401": { - "description": "Unauthorized", + "description": "Unauthorized.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "403": { - "description": "Forbidden", + "description": "Forbidden.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "429": { - "description": "Too many requests", + "description": "Too many requests.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "503": { - "description": "Service unavailable", + "description": "Service unavailable.", "schema": { "$ref": "#/definitions/Error" }, @@ -314,7 +325,7 @@ "Messages" ], "summary": "Gets a message by id.", - "operationId": "GetChatMessage", + "operationId": "ChatThread_GetChatMessage", "produces": [ "application/json" ], @@ -345,28 +356,28 @@ } }, "401": { - "description": "Unauthorized", + "description": "Unauthorized.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "403": { - "description": "Forbidden", + "description": "Forbidden.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "429": { - "description": "Too many requests", + "description": "Too many requests.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "503": { - "description": "Service unavailable", + "description": "Service unavailable.", "schema": { "$ref": "#/definitions/Error" }, @@ -384,7 +395,7 @@ "Messages" ], "summary": "Updates a message.", - "operationId": "UpdateChatMessage", + "operationId": "ChatThread_UpdateChatMessage", "consumes": [ "application/merge-patch+json" ], @@ -424,28 +435,28 @@ "description": "Message is successfully updated." }, "401": { - "description": "Unauthorized", + "description": "Unauthorized.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "403": { - "description": "Forbidden", + "description": "Forbidden.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "429": { - "description": "Too many requests", + "description": "Too many requests.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "503": { - "description": "Service unavailable", + "description": "Service unavailable.", "schema": { "$ref": "#/definitions/Error" }, @@ -463,7 +474,7 @@ "Messages" ], "summary": "Deletes a message.", - "operationId": "DeleteChatMessage", + "operationId": "ChatThread_DeleteChatMessage", "produces": [ "application/json" ], @@ -491,28 +502,28 @@ "description": "Request successful." }, "401": { - "description": "Unauthorized", + "description": "Unauthorized.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "403": { - "description": "Forbidden", + "description": "Forbidden.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "429": { - "description": "Too many requests", + "description": "Too many requests.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "503": { - "description": "Service unavailable", + "description": "Service unavailable.", "schema": { "$ref": "#/definitions/Error" }, @@ -532,7 +543,7 @@ "Messages" ], "summary": "Posts a typing event to a thread, on behalf of a user.", - "operationId": "SendTypingNotification", + "operationId": "ChatThread_SendTypingNotification", "produces": [ "application/json" ], @@ -553,28 +564,28 @@ "description": "Request successful." }, "401": { - "description": "Unauthorized", + "description": "Unauthorized.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "403": { - "description": "Forbidden", + "description": "Forbidden.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "429": { - "description": "Too many requests", + "description": "Too many requests.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "503": { - "description": "Service unavailable", + "description": "Service unavailable.", "schema": { "$ref": "#/definitions/Error" }, @@ -594,7 +605,7 @@ "Participants" ], "summary": "Gets the participants of a thread.", - "operationId": "ListChatParticipants", + "operationId": "ChatThread_ListChatParticipants", "produces": [ "application/json" ], @@ -606,6 +617,20 @@ "required": true, "type": "string" }, + { + "in": "query", + "name": "maxPageSize", + "description": "The maximum number of participants to be returned per page.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "skip", + "description": "Skips participants up to a specified position in response.", + "type": "integer", + "format": "int32" + }, { "$ref": "#/parameters/ApiVersionParameter" } @@ -618,28 +643,28 @@ } }, "401": { - "description": "Unauthorized", + "description": "Unauthorized.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "403": { - "description": "Forbidden", + "description": "Forbidden.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "429": { - "description": "Too many requests", + "description": "Too many requests.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "503": { - "description": "Service unavailable", + "description": "Service unavailable.", "schema": { "$ref": "#/definitions/Error" }, @@ -647,8 +672,8 @@ } }, "x-ms-examples": { - "Get participants": { - "$ref": "./examples/Participants_ListChatParticipants.json" + "Get participants with pagination (max page size)": { + "$ref": "./examples/Participants_ListChatParticipantsWithPageSize.json" } }, "x-ms-pageable": { @@ -661,7 +686,7 @@ "Participants" ], "summary": "Adds thread participants to a thread. If participants already exist, no change occurs.", - "operationId": "AddChatParticipants", + "operationId": "ChatThread_AddChatParticipants", "consumes": [ "application/json" ], @@ -691,31 +716,34 @@ ], "responses": { "201": { - "description": "The participants were successfully added." + "description": "The participants were successfully added.", + "schema": { + "$ref": "#/definitions/AddChatParticipantsResult" + } }, "401": { - "description": "Unauthorized", + "description": "Unauthorized.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "403": { - "description": "Forbidden", + "description": "Forbidden.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "429": { - "description": "Too many requests", + "description": "Too many requests.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "503": { - "description": "Service unavailable", + "description": "Service unavailable.", "schema": { "$ref": "#/definitions/Error" }, @@ -735,7 +763,7 @@ "Participants" ], "summary": "Remove a participant from a thread.", - "operationId": "RemoveChatParticipant", + "operationId": "ChatThread_RemoveChatParticipant", "produces": [ "application/json" ], @@ -763,28 +791,28 @@ "description": "Request successful." }, "401": { - "description": "Unauthorized", + "description": "Unauthorized.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "403": { - "description": "Forbidden", + "description": "Forbidden.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "429": { - "description": "Too many requests", + "description": "Too many requests.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "503": { - "description": "Service unavailable", + "description": "Service unavailable.", "schema": { "$ref": "#/definitions/Error" }, @@ -804,7 +832,7 @@ "Threads" ], "summary": "Creates a chat thread.", - "operationId": "CreateChatThread", + "operationId": "Chat_CreateChatThread", "consumes": [ "application/json" ], @@ -812,6 +840,12 @@ "application/json" ], "parameters": [ + { + "in": "header", + "name": "repeatability-Request-ID", + "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-ID and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-ID is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs.", + "type": "string" + }, { "$ref": "#/parameters/ApiVersionParameter" }, @@ -829,32 +863,32 @@ "201": { "description": "Thread created, the `Location` header would contain the URL for the newly created thread.", "schema": { - "$ref": "#/definitions/ChatThread" + "$ref": "#/definitions/CreateChatThreadResult" } }, "401": { - "description": "Unauthorized", + "description": "Unauthorized.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "403": { - "description": "Forbidden", + "description": "Forbidden.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "429": { - "description": "Too many requests", + "description": "Too many requests.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "503": { - "description": "Service unavailable", + "description": "Service unavailable.", "schema": { "$ref": "#/definitions/Error" }, @@ -864,6 +898,9 @@ "x-ms-examples": { "Create chat thread": { "$ref": "./examples/Threads_CreateChatThread.json" + }, + "Create chat thread with repeatability request id header": { + "$ref": "./examples/Threads_CreateChatThreadWithRepeatabilityRequestId.json" } } }, @@ -872,7 +909,7 @@ "Threads" ], "summary": "Gets the list of chat threads of a user.", - "operationId": "ListChatThreads", + "operationId": "Chat_ListChatThreads", "produces": [ "application/json" ], @@ -903,28 +940,28 @@ } }, "401": { - "description": "Unauthorized", + "description": "Unauthorized.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "403": { - "description": "Forbidden", + "description": "Forbidden.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "429": { - "description": "Too many requests", + "description": "Too many requests.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "503": { - "description": "Service unavailable", + "description": "Service unavailable.", "schema": { "$ref": "#/definitions/Error" }, @@ -948,7 +985,7 @@ "Threads" ], "summary": "Updates a thread's properties.", - "operationId": "UpdateChatThread", + "operationId": "ChatThread_UpdateChatThread", "consumes": [ "application/merge-patch+json" ], @@ -981,28 +1018,28 @@ "description": "Thread was successfully updated." }, "401": { - "description": "Unauthorized", + "description": "Unauthorized.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "403": { - "description": "Forbidden", + "description": "Forbidden.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "429": { - "description": "Too many requests", + "description": "Too many requests.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "503": { - "description": "Service unavailable", + "description": "Service unavailable.", "schema": { "$ref": "#/definitions/Error" }, @@ -1020,7 +1057,7 @@ "Threads" ], "summary": "Gets a chat thread.", - "operationId": "GetChatThread", + "operationId": "Chat_GetChatThread", "produces": [ "application/json" ], @@ -1028,7 +1065,7 @@ { "in": "path", "name": "chatThreadId", - "description": "Thread id to get.", + "description": "Id of the thread.", "required": true, "type": "string" }, @@ -1038,34 +1075,34 @@ ], "responses": { "200": { - "description": "Request successful. The action returns a `Thread` resource.", + "description": "Request successful. The action returns a chat thread.", "schema": { "$ref": "#/definitions/ChatThread" } }, "401": { - "description": "Unauthorized", + "description": "Unauthorized.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "403": { - "description": "Forbidden", + "description": "Forbidden.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "429": { - "description": "Too many requests", + "description": "Too many requests.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "503": { - "description": "Service unavailable", + "description": "Service unavailable.", "schema": { "$ref": "#/definitions/Error" }, @@ -1083,7 +1120,7 @@ "Threads" ], "summary": "Deletes a thread.", - "operationId": "DeleteChatThread", + "operationId": "Chat_DeleteChatThread", "produces": [ "application/json" ], @@ -1091,7 +1128,7 @@ { "in": "path", "name": "chatThreadId", - "description": "Thread id to delete.", + "description": "Id of the thread to be deleted.", "required": true, "type": "string" }, @@ -1104,28 +1141,28 @@ "description": "Request successful." }, "401": { - "description": "Unauthorized", + "description": "Unauthorized.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "403": { - "description": "Forbidden", + "description": "Forbidden.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "429": { - "description": "Too many requests", + "description": "Too many requests.", "schema": { "$ref": "#/definitions/Error" }, "x-ms-error-response": true }, "503": { - "description": "Service unavailable", + "description": "Service unavailable.", "schema": { "$ref": "#/definitions/Error" }, @@ -1146,20 +1183,20 @@ "type": "object", "properties": { "senderId": { - "description": "Chat message read receipt sender id.", + "description": "Id of the participant who read the message.", "type": "string", "readOnly": true, "example": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" }, "chatMessageId": { - "description": "Id for the chat message that has been read. This id is generated by the server.", + "description": "Id of the chat message that has been read. This id is generated by the server.", "type": "string", "readOnly": true, "example": "1591137790240" }, "readOn": { "format": "date-time", - "description": "Chat message read receipt timestamp. The timestamp is in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "description": "The time at which the message was read. The timestamp is in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", "type": "string", "readOnly": true, "example": "2020-10-30T10:50:50Z" @@ -1188,22 +1225,22 @@ "type": "object", "properties": { "code": { - "description": "Error code", + "description": "Error code.", "type": "string", "readOnly": true }, "message": { - "description": "Description of the error", + "description": "Description of the error.", "type": "string", "readOnly": true }, "target": { - "description": "If applicable, would be used to indicate the property causing the error", + "description": "If applicable, would be used to indicate the property causing the error.", "type": "string", "readOnly": true }, "innerErrors": { - "description": "If applicable, inner errors would be returned for more details on the error", + "description": "If applicable, inner errors would be returned for more details on the error.", "type": "array", "items": { "$ref": "#/definitions/Error" @@ -1319,13 +1356,13 @@ }, "deletedOn": { "format": "date-time", - "description": "The timestamp when the chat message was deleted. The timestamp is in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "description": "The timestamp (if applicable) when the message was deleted. The timestamp is in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", "type": "string", "example": "2020-10-30T10:50:50Z" }, "editedOn": { "format": "date-time", - "description": "The timestamp when the chat message was edited. The timestamp is in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "description": "The last timestamp (if applicable) when the message was edited. The timestamp is in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", "type": "string", "example": "2020-10-30T10:50:50Z" } @@ -1422,6 +1459,27 @@ } } }, + "AddChatParticipantsErrors": { + "type": "object", + "properties": { + "invalidParticipants": { + "description": "The participants that failed to be added to the chat thread.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + }, + "readOnly": true + } + } + }, + "AddChatParticipantsResult": { + "type": "object", + "properties": { + "errors": { + "$ref": "#/definitions/AddChatParticipantsErrors" + } + } + }, "CreateChatThreadRequest": { "description": "Request payload for creating a chat thread.", "required": [ @@ -1476,13 +1534,30 @@ "description": "The timestamp when the chat thread was deleted. The timestamp is in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", "type": "string", "example": "2020-10-30T10:50:50Z" - }, - "participants": { - "description": "Chat participants.", + } + } + }, + "CreateChatThreadErrors": { + "type": "object", + "properties": { + "invalidParticipants": { + "description": "The participants that failed to be added to the chat thread.", "type": "array", "items": { - "$ref": "#/definitions/ChatParticipant" - } + "$ref": "#/definitions/Error" + }, + "readOnly": true + } + } + }, + "CreateChatThreadResult": { + "type": "object", + "properties": { + "chatThread": { + "$ref": "#/definitions/ChatThread" + }, + "errors": { + "$ref": "#/definitions/CreateChatThreadErrors" } } }, 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 new file mode 100644 index 000000000000..22dfa271f29a --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Conversations_ListChatReadReceiptsWithPageSize.json @@ -0,0 +1,50 @@ +{ + "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:453dafb77b26481ea2e73bcada0324af@thread.v2/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." + } + } + } +} \ No newline at end of file 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 965f3e6284d0..c1e5a1e5376a 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 @@ -57,7 +57,7 @@ "senderId": "19:453dafb77b26481ea2e73bcada0324af@thread.v2" } ], - "nextLink": "https://contoso.westus.communications.azure.com/chat/threads/19:453dafb77b26481ea2e73bcada0324af@thread.v2/messages?syncState=3e4700000031393a756e6930315f7a626e68336e74326466756666657a6333736f7837646f67377766686b36793571653272776c6e66686c68647a69726968647071407468726561642e763201451fe6e77201000004357fea72010000&startTime=0&maxPageSize=5&api-version=2020-09-21-preview2" + "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/Participants_AddChatParticipants.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_AddChatParticipants.json index 2804cc233ee4..70e10c06c6e0 100644 --- a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_AddChatParticipants.json +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_AddChatParticipants.json @@ -24,8 +24,20 @@ }, "responses": { "201": { - "headers": { - "Azure-Acs-InvalidParticipants": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c,403|8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a,404" + "body": { + "errors": { + "invalidParticipants": [{ + "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c", + "code": "403", + "message": "Permissions check failed" + }, + { + "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", + "code": "404", + "message": "Not found" + } + ] + } } }, "401": { 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 new file mode 100644 index 000000000000..61bd900b7e8d --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_ListChatParticipantsWithPageSize.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-11-01-preview3", + "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2", + "maxPageSize": 2 + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", + "displayName": "Jane", + "shareHistoryTime": "2020-06-06T05:55:41Z" + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "displayName": "Alex", + "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" + } + }, + "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." + } + } + } +} \ No newline at end of file diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_AddChatThreadMembers.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_AddChatThreadMembers.json new file mode 100644 index 000000000000..ffa763486ec8 --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_AddChatThreadMembers.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-11-01-preview3", + "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2", + "addChatThreadMembersRequest": { + "members": [{ + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "displayName": "Alex", + "shareHistoryTime": "2020-06-06T05:55:41Z" + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", + "displayName": "Peter", + "shareHistoryTime": "2020-06-06T05:55:41Z" + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c", + "displayName": "Rama", + "shareHistoryTime": "2020-06-06T05:55:41Z" + } + ] + } + }, + "responses": { + "207": { + "multipleStatus": [{ + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", + "statusCode": 403, + "message": "Permissions check failed" + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "statusCode": 201 + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c", + "statusCode": 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." + } + } + } +} \ No newline at end of file diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_ListChatThreadMembers.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_ListChatThreadMembers.json new file mode 100644 index 000000000000..8486c612548e --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_ListChatThreadMembers.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-11-01-preview3", + "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", + "displayName": "Jane", + "shareHistoryTime": "2020-06-06T05:55:41Z" + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "displayName": "Alex", + "shareHistoryTime": "2020-06-06T05:55:41Z" + } + ], + "nextLink": null + } + }, + "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." + } + } + } +} \ No newline at end of file diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_RemoveChatThreadMember.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_RemoveChatThreadMember.json new file mode 100644 index 000000000000..297d1238b314 --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_RemoveChatThreadMember.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-11-01-preview3", + "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2", + "chatMemberId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a" + }, + "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." + } + } + } +} \ No newline at end of file diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_CreateChatThread.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_CreateChatThread.json index 708aa6f015fe..76fa72dab087 100644 --- a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_CreateChatThread.json +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_CreateChatThread.json @@ -26,23 +26,28 @@ "responses": { "201": { "headers": { - "Location": "https://contoso.westus.communications.azure.com/chat/threads/19%3Auni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", - "Azure-Acs-InvalidParticipants": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c,403|8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10d,404" + "Location": "https://contoso.westus.communications.azure.com/chat/threads/19%3Auni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2" }, "body": { - "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", - "topic": "Lunch", - "createdOn": "2020-06-06T05:55:41.6460000Z", - "createdBy": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", - "participants": [{ - "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", - "shareHistoryTime": "2020-06-06T05:55:41Z" - }, - { - "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", - "shareHistoryTime": "2020-06-06T05:55:41Z" - } - ] + "chatThread": { + "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", + "topic": "Lunch", + "createdOn": "2020-06-06T05:55:41.6460000Z", + "createdBy": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + }, + "errors": { + "invalidParticipants": [{ + "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c", + "code": "403", + "message": "Permissions check failed" + }, + { + "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10d", + "code": "404", + "message": "Not found" + } + ] + } } }, "401": { diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_CreateChatThreadWithRepeatabilityRequestId.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_CreateChatThreadWithRepeatabilityRequestId.json new file mode 100644 index 000000000000..6982775fa7f5 --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_CreateChatThreadWithRepeatabilityRequestId.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-11-01-preview3", + "Repeatability-Request-ID":"35dd6e71-251b-5e29-8376-ba93d09c3fbf", + "createChatThreadRequest": { + "topic": "Lunch", + "participants": [{ + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", + "displayName": "Jane" + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "displayName": "Alex" + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c", + "displayName": "Bob" + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10d", + "displayName": "Peter" + } + ] + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://contoso.westus.communications.azure.com/chat/threads/19%3Auni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2" + }, + "body": { + "chatThread": { + "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", + "topic": "Lunch", + "createdOn": "2020-06-06T05:55:41.6460000Z", + "createdBy": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + }, + "errors": { + "invalidParticipants": [{ + "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c", + "code": "403", + "message": "Permissions check failed" + }, + { + "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10d", + "code": "404", + "message": "Not found" + } + ] + } + } + }, + "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." + } + } + } +} \ No newline at end of file diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_GetChatThread.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_GetChatThread.json index c89bb0e4509a..5c5c3676ad51 100644 --- a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_GetChatThread.json +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_GetChatThread.json @@ -10,16 +10,7 @@ "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", "topic": "Lunch", "createdOn": "2020-06-06T05:55:41.6460000Z", - "createdBy": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", - "participants": [{ - "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", - "shareHistoryTime": "2020-06-06T05:55:41Z" - }, - { - "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", - "shareHistoryTime": "2020-06-06T05:55:41Z" - } - ] + "createdBy": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" } }, "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 9066307a4a55..b9559c7d6083 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 @@ -34,7 +34,7 @@ "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" } ], - "nextLink": "https://contoso.westus.communications.azure.com/chat/threads?syncState=W3sic3RhcnQiOiIyMDIwLTA2LTIzVDIzOjMyOjQ3LjMwNSswMDowMCIsImVuZCI6IjIwMjAtMDYtMjVUMDY6NTY6MjMuNjk2KzAwOjAwIn0seyJzdGFydCI6IjE5NzAtMDEtMDFUMDA6MDA6MDArMDA6MDAiLCJlbmQiOiIxOTcwLTAxLTAxVDAwOjAwOjAwKzAwOjAwIn1d&api-version=2020-09-21-preview2&maxmaxPageSize=5" + "nextLink": "https://contoso.westus.communications.azure.com/chat/threads?syncState=W3sic3RhcnQiOiIyMDIwLTA2LTIzVDIzOjMyOjQ3LjMwNSswMDowMCIsImVuZCI6IjIwMjAtMDYtMjVUMDY6NTY6MjMuNjk2KzAwOjAwIn0seyJzdGFydCI6IjE5NzAtMDEtMDFUMDA6MDA6MDArMDA6MDAiLCJlbmQiOiIxOTcwLTAxLTAxVDAwOjAwOjAwKzAwOjAwIn1d&api-version=2020-11-01-preview3&maxmaxPageSize=5" } }, "401": { From 1aaecbcd82083593785c12dd94c6c44e291d7724 Mon Sep 17 00:00:00 2001 From: Amr Elroumy Date: Mon, 30 Nov 2020 23:23:57 -0800 Subject: [PATCH 3/8] Updating max page size parameter name --- .../2020-11-01-preview3/communicationserviceschat.json | 6 +++--- .../Conversations_ListChatReadReceiptsWithPageSize.json | 4 ++-- .../examples/Messages_ListChatMessagesWithPageSize.json | 4 ++-- .../Participants_ListChatParticipantsWithPageSize.json | 4 ++-- .../examples/Threads_ListChatThreadsWithPageSize.json | 4 ++-- 5 files changed, 11 insertions(+), 11 deletions(-) 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 147fb5aa3779..8b8c6d882df8 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 @@ -26,7 +26,7 @@ }, { "in": "query", - "name": "maxPageSize", + "name": "$maxpagesize", "description": "The maximum number of chat message read receipts to be returned per page.", "type": "integer", "format": "int32" @@ -256,7 +256,7 @@ }, { "in": "query", - "name": "maxPageSize", + "name": "$maxpagesize", "description": "The maximum number of messages to be returned per page.", "type": "integer", "format": "int32" @@ -619,7 +619,7 @@ }, { "in": "query", - "name": "maxPageSize", + "name": "$maxpagesize", "description": "The maximum number of participants to be returned per page.", "type": "integer", "format": "int32" 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 22dfa271f29a..17146358d3dd 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": { @@ -19,7 +19,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/Messages_ListChatMessagesWithPageSize.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_ListChatMessagesWithPageSize.json index c1e5a1e5376a..a80cb7cd4855 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": { @@ -57,7 +57,7 @@ "senderId": "19:453dafb77b26481ea2e73bcada0324af@thread.v2" } ], - "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/Participants_ListChatParticipantsWithPageSize.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_ListChatParticipantsWithPageSize.json index 61bd900b7e8d..1936e98602be 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": { @@ -19,7 +19,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 b9559c7d6083..38f5e7555524 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", - "maxmaxPageSize": 5 + "max$maxpagesize": 5 }, "responses": { "200": { @@ -34,7 +34,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&maxmaxPageSize=5" + "nextLink": "https://contoso.westus.communications.azure.com/chat/threads?syncState=W3sic3RhcnQiOiIyMDIwLTA2LTIzVDIzOjMyOjQ3LjMwNSswMDowMCIsImVuZCI6IjIwMjAtMDYtMjVUMDY6NTY6MjMuNjk2KzAwOjAwIn0seyJzdGFydCI6IjE5NzAtMDEtMDFUMDA6MDA6MDArMDA6MDAiLCJlbmQiOiIxOTcwLTAxLTAxVDAwOjAwOjAwKzAwOjAwIn1d&api-version=2020-11-01-preview3&max$maxpagesize=5" } }, "401": { From ecaee099d9fba1defcb90f4d3cd436bd69368193 Mon Sep 17 00:00:00 2001 From: Amr Elroumy Date: Tue, 1 Dec 2020 00:15:23 -0800 Subject: [PATCH 4/8] update `maxpagesize` parameter name in example file. --- .../examples/Threads_ListChatThreadsWithPageSize.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) 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 38f5e7555524..a260803614fe 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", - "max$maxpagesize": 5 + "$maxpagesize": 5 }, "responses": { "200": { @@ -34,7 +34,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&max$maxpagesize=5" + "nextLink": "https://contoso.westus.communications.azure.com/chat/threads?syncState=W3sic3RhcnQiOiIyMDIwLTA2LTIzVDIzOjMyOjQ3LjMwNSswMDowMCIsImVuZCI6IjIwMjAtMDYtMjVUMDY6NTY6MjMuNjk2KzAwOjAwIn0seyJzdGFydCI6IjE5NzAtMDEtMDFUMDA6MDA6MDArMDA6MDAiLCJlbmQiOiIxOTcwLTAxLTAxVDAwOjAwOjAwKzAwOjAwIn1d&api-version=2020-11-01-preview3&$maxpagesize=5" } }, "401": { From 41129689863600cfb1a6b38dd00d228cb75f57ef Mon Sep 17 00:00:00 2001 From: Amr Elroumy Date: Tue, 1 Dec 2020 10:12:51 -0800 Subject: [PATCH 5/8] Runn prettier on examples --- .../Conversations_ListChatReadReceipts.json | 93 +++++----- ...ions_ListChatReadReceiptsWithPageSize.json | 95 +++++----- .../Conversations_SendChatReadReceipt.json | 68 +++---- .../examples/Messages_DeleteChatMessage.json | 64 +++---- .../examples/Messages_GetChatMessage.json | 86 ++++----- ...Messages_ListChatMessagesWithPageSize.json | 171 +++++++++--------- .../examples/Messages_SendChatMessage.json | 86 ++++----- .../Messages_SendTypingNotification.json | 64 +++---- .../examples/Messages_UpdateChatMessage.json | 72 ++++---- .../Participants_AddChatParticipants.json | 8 +- .../Participants_ListChatParticipants.json | 93 +++++----- ...ants_ListChatParticipantsWithPageSize.json | 95 +++++----- .../Participants_RemoveChatParticipant.json | 64 +++---- .../ThreadMembers_AddChatThreadMembers.json | 8 +- .../ThreadMembers_ListChatThreadMembers.json | 93 +++++----- .../ThreadMembers_RemoveChatThreadMember.json | 64 +++---- .../examples/Threads_CreateChatThread.json | 142 ++++++++------- ...eChatThreadWithRepeatabilityRequestId.json | 144 +++++++-------- .../examples/Threads_DeleteChatThread.json | 62 +++---- .../examples/Threads_GetChatThread.json | 76 ++++---- .../Threads_ListChatThreadsWithPageSize.json | 125 ++++++------- .../Threads_UpdateChatThreadTopic.json | 70 +++---- 22 files changed, 929 insertions(+), 914 deletions(-) diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Conversations_ListChatReadReceipts.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Conversations_ListChatReadReceipts.json index 90244c69e007..eb4a018f3e11 100644 --- a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Conversations_ListChatReadReceipts.json +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Conversations_ListChatReadReceipts.json @@ -1,49 +1,50 @@ { - "parameters": { - "endpoint": "https://contoso.westus.communications.azure.com", - "api-version": "2020-11-01-preview3", - "chatThreadId": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2" + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-11-01-preview3", + "chatThreadId": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2" + }, + "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": null + } }, - "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": null - } - }, - "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." - } - } + "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." + } } -} \ No newline at end of file + } +} 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 17146358d3dd..fc5df4ecc008 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 @@ -1,50 +1,51 @@ { - "parameters": { - "endpoint": "https://contoso.westus.communications.azure.com", - "api-version": "2020-11-01-preview3", - "chatThreadId": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", - "$maxpagesize": 2 + "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:453dafb77b26481ea2e73bcada0324af@thread.v2/readReceipts?skip=2&$maxpagesize=2&api-version=2020-11-01-preview3" + } }, - "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:453dafb77b26481ea2e73bcada0324af@thread.v2/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." - } - } + "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." + } } -} \ No newline at end of file + } +} 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 e902be463679..080f838cca60 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 @@ -1,37 +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" - } + "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." + } }, - "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." - } - } + "503": { + "body": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } } -} \ No newline at end of file + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_DeleteChatMessage.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_DeleteChatMessage.json index 69c1220e4f43..546a568cb910 100644 --- a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_DeleteChatMessage.json +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_DeleteChatMessage.json @@ -1,35 +1,35 @@ { - "parameters": { - "endpoint": "https://contoso.westus.communications.azure.com", - "api-version": "2020-11-01-preview3", - "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "chatMessageId": "1591768249318" + "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." + } }, - "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." - } - } + "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." + } } -} \ No newline at end of file + } +} 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 fa744d68d00c..ca7d28887a95 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 @@ -1,46 +1,46 @@ { - "parameters": { - "endpoint": "https://contoso.westus.communications.azure.com", - "api-version": "2020-11-01-preview3", - "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "chatMessageId": "1591768249318" + "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" + } }, - "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." - } - } + "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." + } } -} \ No newline at end of file + } +} 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 a80cb7cd4855..c825859167b9 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 @@ -1,88 +1,89 @@ { - "parameters": { - "endpoint": "https://contoso.westus.communications.azure.com", - "api-version": "2020-11-01-preview3", - "chatThreadId": "19:453dafb77b26481ea2e73bcada0324af@thread.v2", - "$maxpagesize": 5 + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-11-01-preview3", + "chatThreadId": "19:453dafb77b26481ea2e73bcada0324af@thread.v2", + "$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": "15931069767858:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10bLunch", + "createdOn": "2020-06-25T17:42:56.7850000Z", + "senderId": "19:453dafb77b26481ea2e73bcada0324af@thread.v2" + }, + { + "id": "1593106976753", + "type": "ThreadActivity/AddMember", + "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" + } + ], + "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" + } }, - "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": "15931069767858:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10bLunch", - "createdOn": "2020-06-25T17:42:56.7850000Z", - "senderId": "19:453dafb77b26481ea2e73bcada0324af@thread.v2" - }, - { - "id": "1593106976753", - "type": "ThreadActivity/AddMember", - "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" - } - ], - "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": { - "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." - } - } + "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." + } } -} \ No newline at end of file + } +} 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 4189f17c4363..cf54f781ca1e 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 @@ -1,46 +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" - } + "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." + } }, - "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." - } - } + "503": { + "body": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } } -} \ No newline at end of file + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_SendTypingNotification.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_SendTypingNotification.json index 927bcf57276b..91a4b52d062c 100644 --- a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_SendTypingNotification.json +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_SendTypingNotification.json @@ -1,35 +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" + "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." + } }, - "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." - } - } + "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." + } } -} \ No newline at end of file + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_UpdateChatMessage.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_UpdateChatMessage.json index 5fce4a4cded9..510302aaaa28 100644 --- a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_UpdateChatMessage.json +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Messages_UpdateChatMessage.json @@ -1,39 +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" - } + "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." + } }, - "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." - } - } + "503": { + "body": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } } -} \ No newline at end of file + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_AddChatParticipants.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_AddChatParticipants.json index 70e10c06c6e0..46f81f00db33 100644 --- a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_AddChatParticipants.json +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_AddChatParticipants.json @@ -4,7 +4,8 @@ "api-version": "2020-11-01-preview3", "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2", "addChatParticipantsRequest": { - "participants": [{ + "participants": [ + { "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", "displayName": "Alex", "shareHistoryTime": "2020-06-06T05:55:41Z" @@ -26,7 +27,8 @@ "201": { "body": { "errors": { - "invalidParticipants": [{ + "invalidParticipants": [ + { "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c", "code": "403", "message": "Permissions check failed" @@ -65,4 +67,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_ListChatParticipants.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_ListChatParticipants.json index 8486c612548e..d3677ba66cf4 100644 --- a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_ListChatParticipants.json +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_ListChatParticipants.json @@ -1,49 +1,50 @@ { - "parameters": { - "endpoint": "https://contoso.westus.communications.azure.com", - "api-version": "2020-11-01-preview3", - "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2" + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-11-01-preview3", + "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", + "displayName": "Jane", + "shareHistoryTime": "2020-06-06T05:55:41Z" + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "displayName": "Alex", + "shareHistoryTime": "2020-06-06T05:55:41Z" + } + ], + "nextLink": null + } }, - "responses": { - "200": { - "body": { - "value": [{ - "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", - "displayName": "Jane", - "shareHistoryTime": "2020-06-06T05:55:41Z" - }, - { - "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", - "displayName": "Alex", - "shareHistoryTime": "2020-06-06T05:55:41Z" - } - ], - "nextLink": null - } - }, - "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." - } - } + "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." + } } -} \ No newline at end of file + } +} 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 1936e98602be..c4d504569065 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 @@ -1,50 +1,51 @@ { - "parameters": { - "endpoint": "https://contoso.westus.communications.azure.com", - "api-version": "2020-11-01-preview3", - "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2", - "$maxpagesize": 2 + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-11-01-preview3", + "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2", + "$maxpagesize": 2 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", + "displayName": "Jane", + "shareHistoryTime": "2020-06-06T05:55:41Z" + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "displayName": "Alex", + "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" + } }, - "responses": { - "200": { - "body": { - "value": [{ - "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", - "displayName": "Jane", - "shareHistoryTime": "2020-06-06T05:55:41Z" - }, - { - "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", - "displayName": "Alex", - "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" - } - }, - "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." - } - } + "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." + } } -} \ No newline at end of file + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_RemoveChatParticipant.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_RemoveChatParticipant.json index 1942b3a8c1a1..40d818dbc955 100644 --- a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_RemoveChatParticipant.json +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_RemoveChatParticipant.json @@ -1,35 +1,35 @@ { - "parameters": { - "endpoint": "https://contoso.westus.communications.azure.com", - "api-version": "2020-11-01-preview3", - "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2", - "chatParticipantId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a" + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-11-01-preview3", + "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2", + "chatParticipantId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a" + }, + "responses": { + "204": {}, + "401": { + "body": { + "code": "Unauthorized", + "message": "Request is not authorized." + } }, - "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." - } - } + "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." + } } -} \ No newline at end of file + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_AddChatThreadMembers.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_AddChatThreadMembers.json index ffa763486ec8..0674a7260251 100644 --- a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_AddChatThreadMembers.json +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_AddChatThreadMembers.json @@ -4,7 +4,8 @@ "api-version": "2020-11-01-preview3", "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2", "addChatThreadMembersRequest": { - "members": [{ + "members": [ + { "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", "displayName": "Alex", "shareHistoryTime": "2020-06-06T05:55:41Z" @@ -24,7 +25,8 @@ }, "responses": { "207": { - "multipleStatus": [{ + "multipleStatus": [ + { "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", "statusCode": 403, "message": "Permissions check failed" @@ -64,4 +66,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_ListChatThreadMembers.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_ListChatThreadMembers.json index 8486c612548e..d3677ba66cf4 100644 --- a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_ListChatThreadMembers.json +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_ListChatThreadMembers.json @@ -1,49 +1,50 @@ { - "parameters": { - "endpoint": "https://contoso.westus.communications.azure.com", - "api-version": "2020-11-01-preview3", - "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2" + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-11-01-preview3", + "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", + "displayName": "Jane", + "shareHistoryTime": "2020-06-06T05:55:41Z" + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "displayName": "Alex", + "shareHistoryTime": "2020-06-06T05:55:41Z" + } + ], + "nextLink": null + } }, - "responses": { - "200": { - "body": { - "value": [{ - "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", - "displayName": "Jane", - "shareHistoryTime": "2020-06-06T05:55:41Z" - }, - { - "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", - "displayName": "Alex", - "shareHistoryTime": "2020-06-06T05:55:41Z" - } - ], - "nextLink": null - } - }, - "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." - } - } + "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." + } } -} \ No newline at end of file + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_RemoveChatThreadMember.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_RemoveChatThreadMember.json index 297d1238b314..9732788ef192 100644 --- a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_RemoveChatThreadMember.json +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_RemoveChatThreadMember.json @@ -1,35 +1,35 @@ { - "parameters": { - "endpoint": "https://contoso.westus.communications.azure.com", - "api-version": "2020-11-01-preview3", - "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2", - "chatMemberId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a" + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-11-01-preview3", + "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2", + "chatMemberId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a" + }, + "responses": { + "204": {}, + "401": { + "body": { + "code": "Unauthorized", + "message": "Request is not authorized." + } }, - "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." - } - } + "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." + } } -} \ No newline at end of file + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_CreateChatThread.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_CreateChatThread.json index 76fa72dab087..48bde41c8db1 100644 --- a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_CreateChatThread.json +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_CreateChatThread.json @@ -1,78 +1,80 @@ { - "parameters": { - "endpoint": "https://contoso.westus.communications.azure.com", - "api-version": "2020-11-01-preview3", - "createChatThreadRequest": { - "topic": "Lunch", - "participants": [{ - "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", - "displayName": "Jane" - }, - { - "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", - "displayName": "Alex" - }, - { - "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c", - "displayName": "Bob" - }, - { - "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10d", - "displayName": "Peter" - } - ] - } - }, - "responses": { - "201": { - "headers": { - "Location": "https://contoso.westus.communications.azure.com/chat/threads/19%3Auni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2" - }, - "body": { - "chatThread": { - "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", - "topic": "Lunch", - "createdOn": "2020-06-06T05:55:41.6460000Z", - "createdBy": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" - }, - "errors": { - "invalidParticipants": [{ - "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c", - "code": "403", - "message": "Permissions check failed" - }, - { - "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10d", - "code": "404", - "message": "Not found" - } - ] - } - } + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-11-01-preview3", + "createChatThreadRequest": { + "topic": "Lunch", + "participants": [ + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", + "displayName": "Jane" }, - "401": { - "body": { - "code": "Unauthorized", - "message": "Request is not authorized." - } + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "displayName": "Alex" }, - "403": { - "body": { - "code": "Forbidden", - "message": "User is not allowed to perform specified action." - } + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c", + "displayName": "Bob" }, - "429": { - "body": { - "code": "TooManyRequests", - "message": "Rate limit exceeded." - } + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10d", + "displayName": "Peter" + } + ] + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://contoso.westus.communications.azure.com/chat/threads/19%3Auni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2" + }, + "body": { + "chatThread": { + "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", + "topic": "Lunch", + "createdOn": "2020-06-06T05:55:41.6460000Z", + "createdBy": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" }, - "503": { - "body": { - "code": "ServiceUnavailable", - "message": "The server is currently unable to handle the request." + "errors": { + "invalidParticipants": [ + { + "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c", + "code": "403", + "message": "Permissions check failed" + }, + { + "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10d", + "code": "404", + "message": "Not found" } + ] } + } + }, + "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." + } } -} \ No newline at end of file + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_CreateChatThreadWithRepeatabilityRequestId.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_CreateChatThreadWithRepeatabilityRequestId.json index 6982775fa7f5..048e1328c231 100644 --- a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_CreateChatThreadWithRepeatabilityRequestId.json +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_CreateChatThreadWithRepeatabilityRequestId.json @@ -1,79 +1,81 @@ { - "parameters": { - "endpoint": "https://contoso.westus.communications.azure.com", - "api-version": "2020-11-01-preview3", - "Repeatability-Request-ID":"35dd6e71-251b-5e29-8376-ba93d09c3fbf", - "createChatThreadRequest": { - "topic": "Lunch", - "participants": [{ - "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", - "displayName": "Jane" - }, - { - "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", - "displayName": "Alex" - }, - { - "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c", - "displayName": "Bob" - }, - { - "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10d", - "displayName": "Peter" - } - ] - } - }, - "responses": { - "201": { - "headers": { - "Location": "https://contoso.westus.communications.azure.com/chat/threads/19%3Auni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2" - }, - "body": { - "chatThread": { - "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", - "topic": "Lunch", - "createdOn": "2020-06-06T05:55:41.6460000Z", - "createdBy": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" - }, - "errors": { - "invalidParticipants": [{ - "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c", - "code": "403", - "message": "Permissions check failed" - }, - { - "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10d", - "code": "404", - "message": "Not found" - } - ] - } - } + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-11-01-preview3", + "Repeatability-Request-ID": "35dd6e71-251b-5e29-8376-ba93d09c3fbf", + "createChatThreadRequest": { + "topic": "Lunch", + "participants": [ + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", + "displayName": "Jane" }, - "401": { - "body": { - "code": "Unauthorized", - "message": "Request is not authorized." - } + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "displayName": "Alex" }, - "403": { - "body": { - "code": "Forbidden", - "message": "User is not allowed to perform specified action." - } + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c", + "displayName": "Bob" }, - "429": { - "body": { - "code": "TooManyRequests", - "message": "Rate limit exceeded." - } + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10d", + "displayName": "Peter" + } + ] + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://contoso.westus.communications.azure.com/chat/threads/19%3Auni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2" + }, + "body": { + "chatThread": { + "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", + "topic": "Lunch", + "createdOn": "2020-06-06T05:55:41.6460000Z", + "createdBy": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" }, - "503": { - "body": { - "code": "ServiceUnavailable", - "message": "The server is currently unable to handle the request." + "errors": { + "invalidParticipants": [ + { + "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c", + "code": "403", + "message": "Permissions check failed" + }, + { + "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10d", + "code": "404", + "message": "Not found" } + ] } + } + }, + "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." + } } -} \ No newline at end of file + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_DeleteChatThread.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_DeleteChatThread.json index 01e49e5f76a5..8ae6be923504 100644 --- a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_DeleteChatThread.json +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_DeleteChatThread.json @@ -1,34 +1,34 @@ { - "parameters": { - "endpoint": "https://contoso.westus.communications.azure.com", - "api-version": "2020-11-01-preview3", - "chatThreadId": "19:9525281ac1f947fc884bcee1a9f983c2@thread.v2" + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-11-01-preview3", + "chatThreadId": "19:9525281ac1f947fc884bcee1a9f983c2@thread.v2" + }, + "responses": { + "204": {}, + "401": { + "body": { + "code": "Unauthorized", + "message": "Request is not authorized." + } }, - "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." - } - } + "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." + } } -} \ No newline at end of file + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_GetChatThread.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_GetChatThread.json index 5c5c3676ad51..2b4fcc5f0476 100644 --- a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_GetChatThread.json +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_GetChatThread.json @@ -1,41 +1,41 @@ { - "parameters": { - "endpoint": "https://contoso.westus.communications.azure.com", - "api-version": "2020-11-01-preview3", - "chatThreadId": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2" + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-11-01-preview3", + "chatThreadId": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2" + }, + "responses": { + "200": { + "body": { + "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", + "topic": "Lunch", + "createdOn": "2020-06-06T05:55:41.6460000Z", + "createdBy": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } }, - "responses": { - "200": { - "body": { - "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", - "topic": "Lunch", - "createdOn": "2020-06-06T05:55:41.6460000Z", - "createdBy": "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." - } - } + "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." + } } -} \ No newline at end of file + } +} 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 a260803614fe..661b9f1d5923 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 @@ -1,65 +1,66 @@ { - "parameters": { - "endpoint": "https://contoso.westus.communications.azure.com", - "api-version": "2020-11-01-preview3", - "$maxpagesize": 5 + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-11-01-preview3", + "$maxpagesize": 5 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", + "topic": "Chat with Samantha", + "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" + }, + { + "id": "19:a0dfe5fc10e04a7f8d8a64d455f4196d@thread.v2", + "topic": "Presentation Brainstorming", + "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" + }, + { + "id": "19:uni01_n242d2bzammtwxiib7pbjtozeevjqzavzn654ku3dajocexfo2na@thread.v2", + "topic": "Chat with Alex", + "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" + }, + { + "id": "19:0062022a28be4e0983734f7e45cd8566@thread.v2", + "topic": "Lunch", + "deletedOn": "2020-07-07T05:55:41.6460000Z", + "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" + }, + { + "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpe@thread.v2", + "topic": "Chat with Bob", + "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" + } }, - "responses": { - "200": { - "body": { - "value": [{ - "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", - "topic": "Chat with Samantha", - "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" - }, - { - "id": "19:a0dfe5fc10e04a7f8d8a64d455f4196d@thread.v2", - "topic": "Presentation Brainstorming", - "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" - }, - { - "id": "19:uni01_n242d2bzammtwxiib7pbjtozeevjqzavzn654ku3dajocexfo2na@thread.v2", - "topic": "Chat with Alex", - "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" - }, - { - "id": "19:0062022a28be4e0983734f7e45cd8566@thread.v2", - "topic": "Lunch", - "deletedOn": "2020-07-07T05:55:41.6460000Z", - "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" - }, - { - "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpe@thread.v2", - "topic": "Chat with Bob", - "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" - } - }, - "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." - } - } + "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." + } } -} \ No newline at end of file + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_UpdateChatThreadTopic.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_UpdateChatThreadTopic.json index 22e91473034e..6932fd22adcf 100644 --- a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_UpdateChatThreadTopic.json +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Threads_UpdateChatThreadTopic.json @@ -1,38 +1,38 @@ { - "parameters": { - "endpoint": "https://contoso.westus.communications.azure.com", - "content-type": "application/merge-patch+json", - "api-version": "2020-11-01-preview3", - "chatThreadId": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", - "updateChatThreadRequest": { - "topic": "Updated Thread Topic" - } + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "content-type": "application/merge-patch+json", + "api-version": "2020-11-01-preview3", + "chatThreadId": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", + "updateChatThreadRequest": { + "topic": "Updated Thread Topic" + } + }, + "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." + } }, - "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." - } - } + "503": { + "body": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } } -} \ No newline at end of file + } +} From f18e4c30b504c5ef4e56d722e97929ad160fa68b Mon Sep 17 00:00:00 2001 From: Amr Elroumy Date: Tue, 1 Dec 2020 11:40:52 -0800 Subject: [PATCH 6/8] Removing obsolete example files, and adding missing description properties. --- .../communicationserviceschat.json | 37 ++++++---- .../Conversations_ListChatReadReceipts.json | 50 -------------- .../Participants_ListChatParticipants.json | 50 -------------- .../ThreadMembers_AddChatThreadMembers.json | 69 ------------------- .../ThreadMembers_ListChatThreadMembers.json | 50 -------------- .../ThreadMembers_RemoveChatThreadMember.json | 35 ---------- 6 files changed, 24 insertions(+), 267 deletions(-) delete mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Conversations_ListChatReadReceipts.json delete mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_ListChatParticipants.json delete mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_AddChatThreadMembers.json delete mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_ListChatThreadMembers.json delete mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_RemoveChatThreadMember.json 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 8b8c6d882df8..5e93f2cb1691 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 @@ -264,7 +264,7 @@ { "in": "query", "name": "startTime", - "description": "The earliest point in time to get messages up to. The timestamp should be in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "description": "The earliest point in time to get messages up to. The timestamp should be in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", "type": "string", "format": "date-time" }, @@ -924,7 +924,7 @@ { "in": "query", "name": "startTime", - "description": "The earliest point in time to get chat threads up to. The timestamp should be in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "description": "The earliest point in time to get chat threads up to. The timestamp should be in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", "type": "string", "format": "date-time" }, @@ -1196,7 +1196,7 @@ }, "readOn": { "format": "date-time", - "description": "The time at which the message was read. The timestamp is in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "description": "The time at which the message was read. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", "type": "string", "readOnly": true, "example": "2020-10-30T10:50:50Z" @@ -1204,6 +1204,7 @@ } }, "ChatMessageReadReceiptsCollection": { + "description": "A paged collection of chat message read receipts.", "type": "object", "properties": { "value": { @@ -1222,6 +1223,7 @@ } }, "Error": { + "description": "Error encountered while performing an operation.", "type": "object", "properties": { "code": { @@ -1310,6 +1312,7 @@ } }, "ChatMessage": { + "description": "Chat message.", "type": "object", "properties": { "id": { @@ -1343,7 +1346,7 @@ }, "createdOn": { "format": "date-time", - "description": "The timestamp when the chat message arrived at the server. The timestamp is in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "description": "The timestamp when the chat message arrived at the server. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", "type": "string", "readOnly": true, "example": "2020-10-30T10:50:50Z" @@ -1356,13 +1359,13 @@ }, "deletedOn": { "format": "date-time", - "description": "The timestamp (if applicable) when the message was deleted. The timestamp is in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "description": "The timestamp (if applicable) when the message was deleted. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", "type": "string", "example": "2020-10-30T10:50:50Z" }, "editedOn": { "format": "date-time", - "description": "The last timestamp (if applicable) when the message was edited. The timestamp is in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "description": "The last timestamp (if applicable) when the message was edited. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", "type": "string", "example": "2020-10-30T10:50:50Z" } @@ -1388,6 +1391,7 @@ } }, "UpdateChatMessageRequest": { + "description": "Request payload for updating a chat message.", "type": "object", "properties": { "content": { @@ -1419,7 +1423,7 @@ }, "shareHistoryTime": { "format": "date-time", - "description": "Time from which the chat history is shared with the participant. The timestamp is in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "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" } @@ -1460,6 +1464,7 @@ } }, "AddChatParticipantsErrors": { + "description": "Errors encountered during the addition of the chat participant to the chat thread.", "type": "object", "properties": { "invalidParticipants": { @@ -1473,6 +1478,7 @@ } }, "AddChatParticipantsResult": { + "description": "Result of the add chat participants operation.", "type": "object", "properties": { "errors": { @@ -1503,6 +1509,7 @@ } }, "ChatThread": { + "description": "Chat thread.", "type": "object", "properties": { "id": { @@ -1518,7 +1525,7 @@ }, "createdOn": { "format": "date-time", - "description": "The timestamp when the chat thread was created. The timestamp is in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "description": "The timestamp when the chat thread was created. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", "type": "string", "readOnly": true, "example": "2020-10-30T10:50:50Z" @@ -1531,13 +1538,14 @@ }, "deletedOn": { "format": "date-time", - "description": "The timestamp when the chat thread was deleted. The timestamp is in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "description": "The timestamp when the chat thread was deleted. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", "type": "string", "example": "2020-10-30T10:50:50Z" } } }, "CreateChatThreadErrors": { + "description": "Errors encountered during the creation of the chat thread.", "type": "object", "properties": { "invalidParticipants": { @@ -1551,6 +1559,7 @@ } }, "CreateChatThreadResult": { + "description": "Result of the create chat thread operation.", "type": "object", "properties": { "chatThread": { @@ -1562,6 +1571,7 @@ } }, "ChatThreadInfo": { + "description": "Summary information of a chat thread.", "type": "object", "properties": { "id": { @@ -1577,13 +1587,13 @@ }, "deletedOn": { "format": "date-time", - "description": "The timestamp when the chat thread was deleted. The timestamp is in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "description": "The timestamp when the chat thread was deleted. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", "type": "string", "example": "2020-10-30T10:50:50Z" }, "lastMessageReceivedOn": { "format": "date-time", - "description": "The timestamp when the last message arrived at the server. The timestamp is in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "description": "The timestamp when the last message arrived at the server. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", "type": "string", "readOnly": true, "example": "2020-10-30T10:50:50Z" @@ -1610,6 +1620,7 @@ } }, "UpdateChatThreadRequest": { + "description": "Request payload for updating a chat thread.", "type": "object", "properties": { "topic": { @@ -1649,7 +1660,7 @@ }, "security": [ { - "Authorization": [ ] + "Authorization": [] } ], "x-ms-parameterized-host": { @@ -1661,4 +1672,4 @@ } ] } -} \ No newline at end of file +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Conversations_ListChatReadReceipts.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Conversations_ListChatReadReceipts.json deleted file mode 100644 index eb4a018f3e11..000000000000 --- a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Conversations_ListChatReadReceipts.json +++ /dev/null @@ -1,50 +0,0 @@ -{ - "parameters": { - "endpoint": "https://contoso.westus.communications.azure.com", - "api-version": "2020-11-01-preview3", - "chatThreadId": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2" - }, - "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": null - } - }, - "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." - } - } - } -} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_ListChatParticipants.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_ListChatParticipants.json deleted file mode 100644 index d3677ba66cf4..000000000000 --- a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/Participants_ListChatParticipants.json +++ /dev/null @@ -1,50 +0,0 @@ -{ - "parameters": { - "endpoint": "https://contoso.westus.communications.azure.com", - "api-version": "2020-11-01-preview3", - "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", - "displayName": "Jane", - "shareHistoryTime": "2020-06-06T05:55:41Z" - }, - { - "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", - "displayName": "Alex", - "shareHistoryTime": "2020-06-06T05:55:41Z" - } - ], - "nextLink": null - } - }, - "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." - } - } - } -} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_AddChatThreadMembers.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_AddChatThreadMembers.json deleted file mode 100644 index 0674a7260251..000000000000 --- a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_AddChatThreadMembers.json +++ /dev/null @@ -1,69 +0,0 @@ -{ - "parameters": { - "endpoint": "https://contoso.westus.communications.azure.com", - "api-version": "2020-11-01-preview3", - "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2", - "addChatThreadMembersRequest": { - "members": [ - { - "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", - "displayName": "Alex", - "shareHistoryTime": "2020-06-06T05:55:41Z" - }, - { - "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", - "displayName": "Peter", - "shareHistoryTime": "2020-06-06T05:55:41Z" - }, - { - "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c", - "displayName": "Rama", - "shareHistoryTime": "2020-06-06T05:55:41Z" - } - ] - } - }, - "responses": { - "207": { - "multipleStatus": [ - { - "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", - "statusCode": 403, - "message": "Permissions check failed" - }, - { - "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", - "statusCode": 201 - }, - { - "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c", - "statusCode": 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." - } - } - } -} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_ListChatThreadMembers.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_ListChatThreadMembers.json deleted file mode 100644 index d3677ba66cf4..000000000000 --- a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_ListChatThreadMembers.json +++ /dev/null @@ -1,50 +0,0 @@ -{ - "parameters": { - "endpoint": "https://contoso.westus.communications.azure.com", - "api-version": "2020-11-01-preview3", - "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", - "displayName": "Jane", - "shareHistoryTime": "2020-06-06T05:55:41Z" - }, - { - "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", - "displayName": "Alex", - "shareHistoryTime": "2020-06-06T05:55:41Z" - } - ], - "nextLink": null - } - }, - "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." - } - } - } -} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_RemoveChatThreadMember.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_RemoveChatThreadMember.json deleted file mode 100644 index 9732788ef192..000000000000 --- a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples/ThreadMembers_RemoveChatThreadMember.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "endpoint": "https://contoso.westus.communications.azure.com", - "api-version": "2020-11-01-preview3", - "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2", - "chatMemberId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a" - }, - "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." - } - } - } -} From dd8a1a3feaedc93d04817777e8b1392c49eaa4ae Mon Sep 17 00:00:00 2001 From: Amr Elroumy Date: Thu, 3 Dec 2020 13:26:19 -0800 Subject: [PATCH 7/8] Update `maxpagesize` query parameter name for `ListChatThreads` --- .../preview/2020-11-01-preview3/communicationserviceschat.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 5e93f2cb1691..590253e2080d 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 @@ -916,7 +916,7 @@ "parameters": [ { "in": "query", - "name": "maxPageSize", + "name": "$maxpagesize", "description": "The maximum number of chat threads returned per page.", "type": "integer", "format": "int32" From 7e9b88bc8b5e871b553eba162b5fa09b690f3580 Mon Sep 17 00:00:00 2001 From: Amr Elroumy Date: Mon, 7 Dec 2020 21:50:41 -0800 Subject: [PATCH 8/8] rename $maxpagesize to `maxPageSize` --- .../2020-11-01-preview3/communicationserviceschat.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) 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 590253e2080d..dbf06d7ac34d 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 @@ -26,7 +26,7 @@ }, { "in": "query", - "name": "$maxpagesize", + "name": "maxPageSize", "description": "The maximum number of chat message read receipts to be returned per page.", "type": "integer", "format": "int32" @@ -256,7 +256,7 @@ }, { "in": "query", - "name": "$maxpagesize", + "name": "maxPageSize", "description": "The maximum number of messages to be returned per page.", "type": "integer", "format": "int32" @@ -619,7 +619,7 @@ }, { "in": "query", - "name": "$maxpagesize", + "name": "maxPageSize", "description": "The maximum number of participants to be returned per page.", "type": "integer", "format": "int32" @@ -916,7 +916,7 @@ "parameters": [ { "in": "query", - "name": "$maxpagesize", + "name": "maxPageSize", "description": "The maximum number of chat threads returned per page.", "type": "integer", "format": "int32"