Skip to content

Commit 5666603

Browse files
committed
address certification comments
1 parent 7d673d2 commit 5666603

File tree

3 files changed

+80
-32
lines changed

3 files changed

+80
-32
lines changed
Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,19 @@
1-
# Azure Communication Services Chat Connector
2-
3-
This Chat Connector can be used to add real-time text communication to your cross-platform applications. You can read more about Azure Communication Services Chat [here](https://docs.microsoft.com/en-us/rest/api/communication/chat/chat-thread).
1+
# Azure Communication Services Chat
2+
This Chat Connector can manage users in a chat, create chats threads, and send messages in a chat. [API ref for chat](https://docs.microsoft.com/en-us/rest/api/communication/chat/chat), [API ref for chat thread](https://docs.microsoft.com/en-us/rest/api/communication/chat/chat-thread).
43

54
## Publisher: Microsoft
65

76
## Prerequisites
8-
97
You will need the following to proceed:
108
* A Microsoft Power Apps or Power Automate plan with custom connector feature
119
* An Azure subscription
1210
* An Azure Communication Services resource
1311

14-
### Set up an Azure Communication Services resource
15-
- [Quickstart doc](https://review.docs.microsoft.com/en-us/azure/communication-services/quickstarts/create-communication-resource?branch=main&tabs=windows&pivots=platform-azp)
16-
17-
18-
## Obtaining Credentials
19-
20-
### Connection String Authentication
21-
You can create a new connection using an [Azure Communication Services resource connection string](https://docs.microsoft.com/en-us/azure/communication-services/quickstarts/create-communication-resource?tabs=windows&pivots=platform-azp#access-your-connection-strings-and-service-endpoints).
22-
23-
## Deployment Instructions
24-
25-
Run the following commands and follow the prompts:
26-
27-
```paconn
28-
paconn create --api-def .\apiDefinition.swagger.json --api-prop .\apiProperties.json --script .\script.csx --icon .\icon.png
29-
```
30-
3112
## Supported Operations
13+
The connector supports the following operations:
3214

3315
### Send Chat
34-
Send a chat to a sepcified chat thread given an access token.
16+
Send a chat to a specified chat thread given an access token.
3517

3618
### Create Chat
3719
Create a chat given a chat topic.
@@ -46,10 +28,27 @@ List Messages From Thread.
4628
Get the properties of a chat thread.
4729

4830
### Add Participant
49-
Add a participant to a chat thread
31+
Add a participant to a chat thread.
5032

5133
### Remove Participant
52-
Remove a participant from a chat thread
34+
Remove a participant from a chat thread.
5335

5436
### List Participants
55-
List participants in a chat thread
37+
List participants in a chat thread.
38+
39+
## Obtaining Credentials
40+
41+
1 Set up an Azure Communication Services resource
42+
- [Quickstart doc](https://review.docs.microsoft.com/en-us/azure/communication-services/quickstarts/create-communication-resource?branch=pr-en-us-192537&tabs=windows&pivots=platform-azp)
43+
44+
2 Connection String Authentication
45+
- You can create a new connection using an [Azure Communication Services resource endpoint url](https://docs.microsoft.com/en-us/azure/communication-services/quickstarts/create-communication-resource?tabs=windows&pivots=platform-azp#access-your-connection-strings-and-service-endpoints).
46+
47+
## Known Issues and Limitations
48+
Does not support Service principal (Azure AD application) Authentication at this time.
49+
50+
## Deployment Instructions
51+
Run the following commands and follow the prompts:
52+
```paconn
53+
paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json --script script.csx --icon icon.png
54+
```

certified-connectors/Azure Communication Services Chat/apiDefinition.swagger.json

Lines changed: 53 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"swagger": "2.0",
33
"info": {
4-
"title": "Azure Communication Services Chat",
4+
"title": "Azure Communication Chat",
55
"description": "Connector to utilize Azure Communication Services Chat features.",
66
"version": "1.0",
77
"x-ms-api-annotation": {
@@ -42,7 +42,7 @@
4242
"/chat/threads/{chatThreadId}/messages": {
4343
"get": {
4444
"responses": {
45-
"201": {
45+
"200": {
4646
"description": "Success.",
4747
"schema": {
4848
"type": "object",
@@ -124,6 +124,12 @@
124124
}
125125
}
126126
}
127+
},
128+
"401": {
129+
"description": "Unauthorized"
130+
},
131+
"403": {
132+
"description": "Forbidden"
127133
}
128134
},
129135
"summary": "List chat thread messages",
@@ -160,6 +166,12 @@
160166
}
161167
}
162168
}
169+
},
170+
"401": {
171+
"description": "Unauthorized"
172+
},
173+
"403": {
174+
"description": "Forbidden"
163175
}
164176
},
165177
"summary": "Send message to thread",
@@ -207,6 +219,12 @@
207219
"responses": {
208220
"201": {
209221
"description": "Success."
222+
},
223+
"401": {
224+
"description": "Unauthorized"
225+
},
226+
"403": {
227+
"description": "Forbidden"
210228
}
211229
},
212230
"summary": "Add chat thread participants",
@@ -263,6 +281,12 @@
263281
"responses": {
264282
"204": {
265283
"description": "Success."
284+
},
285+
"401": {
286+
"description": "Unauthorized"
287+
},
288+
"403": {
289+
"description": "Forbidden"
266290
}
267291
},
268292
"summary": "Remove chat thread participant",
@@ -292,7 +316,7 @@
292316
"/chat/threads": {
293317
"get": {
294318
"responses": {
295-
"201": {
319+
"200": {
296320
"description": "Success.",
297321
"schema": {
298322
"type": "object",
@@ -334,6 +358,12 @@
334358
}
335359
}
336360
}
361+
},
362+
"401": {
363+
"description": "Unauthorized"
364+
},
365+
"403": {
366+
"description": "Forbidden"
337367
}
338368
},
339369
"summary": "List chat threads",
@@ -387,6 +417,12 @@
387417
}
388418
}
389419
}
420+
},
421+
"401": {
422+
"description": "Unauthorized"
423+
},
424+
"403": {
425+
"description": "Forbidden"
390426
}
391427
},
392428
"summary": "Create chat thread",
@@ -441,7 +477,7 @@
441477
"/chat/threads/{chatThreadId}/participants": {
442478
"get": {
443479
"responses": {
444-
"201": {
480+
"200": {
445481
"description": "Success.",
446482
"schema": {
447483
"type": "object",
@@ -474,6 +510,12 @@
474510
}
475511
}
476512
}
513+
},
514+
"401": {
515+
"description": "Unauthorized"
516+
},
517+
"403": {
518+
"description": "Forbidden"
477519
}
478520
},
479521
"summary": "List chat thread participants",
@@ -501,7 +543,7 @@
501543
"/chat/threads/{chatThreadId}": {
502544
"get": {
503545
"responses": {
504-
"201": {
546+
"200": {
505547
"description": "Success.",
506548
"schema": {
507549
"type": "object",
@@ -544,6 +586,12 @@
544586
}
545587
}
546588
}
589+
},
590+
"401": {
591+
"description": "Unauthorized"
592+
},
593+
"403": {
594+
"description": "Forbidden"
547595
}
548596
},
549597
"operationId": "GetThreadProperties",

certified-connectors/Azure Communication Services Chat/apiProperties.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,10 @@
1515
}
1616
}
1717
},
18-
"iconBrandColor": "#3C1D6E",
18+
"iconBrandColor": "#007ee5",
1919
"capabilities": [],
2020
"policyTemplateInstances": [],
21-
"publisher": "Microsoft"
21+
"publisher": "Microsoft",
22+
"stackOwner": "Microsoft"
2223
}
2324
}

0 commit comments

Comments
 (0)