Skip to content

Commit e9f9fa4

Browse files
navali-msftAndrew Sager
authored andcommitted
Added 'required' property for some of the types (Azure#14893)
* Added required property for some of the type so sdk doesn't mark them as nullables * update descriptions
1 parent 8cc6205 commit e9f9fa4

File tree

1 file changed

+42
-6
lines changed

1 file changed

+42
-6
lines changed

specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/communicationservicescallingserver.json

Lines changed: 42 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -980,6 +980,9 @@
980980
},
981981
"PlayAudioResult": {
982982
"description": "The response payload for play audio operation.",
983+
"required": [
984+
"status"
985+
],
983986
"type": "object",
984987
"properties": {
985988
"operationId": {
@@ -1001,20 +1004,24 @@
10011004
},
10021005
"ResultInfo": {
10031006
"description": "Result info class to be used to report result status for actions/operations.",
1007+
"required": [
1008+
"code",
1009+
"subcode"
1010+
],
10041011
"type": "object",
10051012
"properties": {
10061013
"code": {
10071014
"format": "int32",
1008-
"description": "Gets or sets the result code\r\nFor synchronous failures, this maps one-to-one with HTTP responses. For asynchronous failures or messages, it is contextual.",
1015+
"description": "The result code associated with the operation.",
10091016
"type": "integer"
10101017
},
10111018
"subcode": {
10121019
"format": "int32",
1013-
"description": "Gets or sets the result subcode.\r\nThe subcode further classifies a failure. For example.",
1020+
"description": "The subcode that further classifies the result.",
10141021
"type": "integer"
10151022
},
10161023
"message": {
1017-
"description": "Gets or sets the message\r\nThe message is a detail explanation of subcode.",
1024+
"description": "The message is a detail explanation of subcode.",
10181025
"type": "string"
10191026
}
10201027
}
@@ -1031,6 +1038,9 @@
10311038
},
10321039
"CancelAllMediaOperationsResult": {
10331040
"description": "The response payload of the cancel all media operations.",
1041+
"required": [
1042+
"status"
1043+
],
10341044
"type": "object",
10351045
"properties": {
10361046
"operationId": {
@@ -1116,6 +1126,9 @@
11161126
},
11171127
"CallRecordingProperties": {
11181128
"description": "The response payload of get call recording properties operation.",
1129+
"required": [
1130+
"recordingState"
1131+
],
11191132
"type": "object",
11201133
"properties": {
11211134
"recordingState": {
@@ -1186,6 +1199,9 @@
11861199
},
11871200
"CallConnectionStateChangedEvent": {
11881201
"description": "The call connection state changed event.",
1202+
"required": [
1203+
"callConnectionState"
1204+
],
11891205
"type": "object",
11901206
"properties": {
11911207
"serverCallId": {
@@ -1203,6 +1219,10 @@
12031219
},
12041220
"CallRecordingStateChangeEvent": {
12051221
"description": "The call recording state change event.",
1222+
"required": [
1223+
"state",
1224+
"startDateTime"
1225+
],
12061226
"type": "object",
12071227
"properties": {
12081228
"recordingId": {
@@ -1224,6 +1244,9 @@
12241244
}
12251245
},
12261246
"AddParticipantResultEvent": {
1247+
"required": [
1248+
"status"
1249+
],
12271250
"type": "object",
12281251
"properties": {
12291252
"resultInfo": {
@@ -1258,6 +1281,9 @@
12581281
},
12591282
"CallParticipant": {
12601283
"description": "A participant in a call.",
1284+
"required": [
1285+
"isMuted"
1286+
],
12611287
"type": "object",
12621288
"properties": {
12631289
"identifier": {
@@ -1276,6 +1302,9 @@
12761302
},
12771303
"PlayAudioResultEvent": {
12781304
"description": "The play audio result event.",
1305+
"required": [
1306+
"status"
1307+
],
12791308
"type": "object",
12801309
"properties": {
12811310
"resultInfo": {
@@ -1293,6 +1322,9 @@
12931322
},
12941323
"ToneReceivedEvent": {
12951324
"description": "The subscribe to tone event",
1325+
"required": [
1326+
"toneInfo"
1327+
],
12961328
"type": "object",
12971329
"properties": {
12981330
"toneInfo": {
@@ -1306,7 +1338,7 @@
13061338
}
13071339
},
13081340
"ToneValue": {
1309-
"description": "Gets or sets the tone detected.",
1341+
"description": "The tone value.",
13101342
"enum": [
13111343
"tone0",
13121344
"tone1",
@@ -1333,12 +1365,16 @@
13331365
}
13341366
},
13351367
"ToneInfo": {
1336-
"description": "Gets or sets the tone info",
1368+
"description": "The information about the tone.",
1369+
"required": [
1370+
"sequenceId",
1371+
"tone"
1372+
],
13371373
"type": "object",
13381374
"properties": {
13391375
"sequenceId": {
13401376
"format": "int32",
1341-
"description": "Gets or sets the sequence id. This id can be used to determine if the same tone \r\nwas played multiple times or if any tones were missed.",
1377+
"description": "The sequence id which can be used to determine if the same tone was played multiple times or if any tones were missed.",
13421378
"type": "integer"
13431379
},
13441380
"tone": {

0 commit comments

Comments
 (0)