Skip to content

Commit 413a626

Browse files
srnagarsrnagar
authored
Update event description to include the event name (Azure#13867)
* Update event description to include the event name * Update readme to include guidelines for defining a new event * Fix description
1 parent ad1866d commit 413a626

File tree

12 files changed

+110
-87
lines changed

12 files changed

+110
-87
lines changed

‎specification/eventgrid/data-plane/Microsoft.AppConfiguration/stable/2018-01-01/AppConfiguration.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"paths": {},
99
"definitions": {
1010
"AppConfigurationKeyValueModifiedEventData": {
11-
"description": "Schema of the Data property of an EventGridEvent for an Microsoft.AppConfiguration.KeyValueModified event.",
11+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.AppConfiguration.KeyValueModified event.",
1212
"type": "object",
1313
"properties": {
1414
"key": {
@@ -30,7 +30,7 @@
3030
}
3131
},
3232
"AppConfigurationKeyValueDeletedEventData": {
33-
"description": "Schema of the Data property of an EventGridEvent for an Microsoft.AppConfiguration.KeyValueDeleted event.",
33+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.AppConfiguration.KeyValueDeleted event.",
3434
"type": "object",
3535
"properties": {
3636
"key": {

‎specification/eventgrid/data-plane/Microsoft.Cache/stable/2018-01-01/RedisCache.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"paths": {},
99
"definitions": {
1010
"RedisPatchingCompletedEventData": {
11-
"description": "Schema of the Data property of an EventGridEvent for an Microsoft.Cache.PatchingCompleted event.",
11+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.Cache.PatchingCompleted event.",
1212
"type": "object",
1313
"properties": {
1414
"timestamp": {
@@ -27,7 +27,7 @@
2727
}
2828
},
2929
"RedisScalingCompletedEventData": {
30-
"description": "Schema of the Data property of an EventGridEvent for an Microsoft.Cache.ScalingCompleted event.",
30+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.Cache.ScalingCompleted event.",
3131
"type": "object",
3232
"properties": {
3333
"timestamp": {
@@ -46,7 +46,7 @@
4646
}
4747
},
4848
"RedisExportRDBCompletedEventData": {
49-
"description": "Schema of the Data property of an EventGridEvent for an Microsoft.Cache.ExportRDBCompleted event.",
49+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.Cache.ExportRDBCompleted event.",
5050
"type": "object",
5151
"properties": {
5252
"timestamp": {
@@ -65,7 +65,7 @@
6565
}
6666
},
6767
"RedisImportRDBCompletedEventData": {
68-
"description": "Schema of the Data property of an EventGridEvent for an Microsoft.Cache.ImportRDBCompleted event.",
68+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.Cache.ImportRDBCompleted event.",
6969
"type": "object",
7070
"properties": {
7171
"timestamp": {

‎specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"paths": {},
99
"definitions": {
1010
"AcsChatMessageReceivedEventData": {
11-
"description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatMessageReceived event.",
11+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageReceived event.",
1212
"allOf": [
1313
{
1414
"$ref": "#/definitions/AcsChatMessageEventBaseProperties"
@@ -22,7 +22,7 @@
2222
}
2323
},
2424
"AcsChatMessageReceivedInThreadEventData": {
25-
"description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatMessageReceivedInThread event.",
25+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageReceivedInThread event.",
2626
"allOf": [
2727
{
2828
"$ref": "#/definitions/AcsChatMessageEventInThreadBaseProperties"
@@ -36,7 +36,7 @@
3636
}
3737
},
3838
"AcsChatMessageEditedEventData": {
39-
"description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatMessageEdited event.",
39+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageEdited event.",
4040
"allOf": [
4141
{
4242
"$ref": "#/definitions/AcsChatMessageEventBaseProperties"
@@ -55,7 +55,7 @@
5555
}
5656
},
5757
"AcsChatMessageEditedInThreadEventData": {
58-
"description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatMessageEditedInThread event.",
58+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageEditedInThread event.",
5959
"allOf": [
6060
{
6161
"$ref": "#/definitions/AcsChatMessageEventInThreadBaseProperties"
@@ -74,7 +74,7 @@
7474
}
7575
},
7676
"AcsChatMessageDeletedEventData": {
77-
"description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatMessageDeleted event.",
77+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageDeleted event.",
7878
"allOf": [
7979
{
8080
"$ref": "#/definitions/AcsChatMessageEventBaseProperties"
@@ -89,7 +89,7 @@
8989
}
9090
},
9191
"AcsChatMessageDeletedInThreadEventData": {
92-
"description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatMessageDeletedInThread event.",
92+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageDeletedInThread event.",
9393
"allOf": [
9494
{
9595
"$ref": "#/definitions/AcsChatMessageEventInThreadBaseProperties"
@@ -104,7 +104,7 @@
104104
}
105105
},
106106
"AcsChatThreadCreatedWithUserEventData": {
107-
"description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatThreadCreatedWithUser event.",
107+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadCreatedWithUser event.",
108108
"allOf": [
109109
{
110110
"$ref": "#/definitions/AcsChatThreadEventBaseProperties"
@@ -132,7 +132,7 @@
132132
}
133133
},
134134
"AcsChatThreadCreatedEventData": {
135-
"description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatThreadCreated event.",
135+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadCreated event.",
136136
"allOf": [
137137
{
138138
"$ref": "#/definitions/AcsChatThreadEventInThreadBaseProperties"
@@ -160,7 +160,7 @@
160160
}
161161
},
162162
"AcsChatThreadWithUserDeletedEventData": {
163-
"description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatThreadWithUserDeleted event.",
163+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadWithUserDeleted event.",
164164
"allOf": [
165165
{
166166
"$ref": "#/definitions/AcsChatThreadEventBaseProperties"
@@ -179,7 +179,7 @@
179179
}
180180
},
181181
"AcsChatThreadDeletedEventData": {
182-
"description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatThreadDeleted event.",
182+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadDeleted event.",
183183
"allOf": [
184184
{
185185
"$ref": "#/definitions/AcsChatThreadEventInThreadBaseProperties"
@@ -198,7 +198,7 @@
198198
}
199199
},
200200
"AcsChatThreadPropertiesUpdatedPerUserEventData": {
201-
"description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatThreadPropertiesUpdatedPerUser event.",
201+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadPropertiesUpdatedPerUser event.",
202202
"allOf": [
203203
{
204204
"$ref": "#/definitions/AcsChatThreadEventBaseProperties"
@@ -224,7 +224,7 @@
224224
}
225225
},
226226
"AcsChatThreadPropertiesUpdatedEventData": {
227-
"description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatThreadPropertiesUpdated event.",
227+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadPropertiesUpdated event.",
228228
"allOf": [
229229
{
230230
"$ref": "#/definitions/AcsChatThreadEventInThreadBaseProperties"
@@ -250,7 +250,7 @@
250250
}
251251
},
252252
"AcsChatParticipantAddedToThreadWithUserEventData": {
253-
"description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatParticipantAddedToThreadWithUser event.",
253+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatParticipantAddedToThreadWithUser event.",
254254
"allOf": [
255255
{
256256
"$ref": "#/definitions/AcsChatThreadEventBaseProperties"
@@ -273,7 +273,7 @@
273273
}
274274
},
275275
"AcsChatParticipantRemovedFromThreadWithUserEventData": {
276-
"description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatParticipantRemovedFromThreadWithUser event.",
276+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatParticipantRemovedFromThreadWithUser event.",
277277
"allOf": [
278278
{
279279
"$ref": "#/definitions/AcsChatThreadEventBaseProperties"
@@ -296,7 +296,7 @@
296296
}
297297
},
298298
"AcsChatParticipantAddedToThreadEventData": {
299-
"description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatThreadParticipantAdded event.",
299+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadParticipantAdded event.",
300300
"allOf": [
301301
{
302302
"$ref": "#/definitions/AcsChatEventInThreadBaseProperties"
@@ -324,7 +324,7 @@
324324
}
325325
},
326326
"AcsChatParticipantRemovedFromThreadEventData": {
327-
"description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatThreadParticipantRemoved event.",
327+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadParticipantRemoved event.",
328328
"allOf": [
329329
{
330330
"$ref": "#/definitions/AcsChatEventInThreadBaseProperties"
@@ -352,7 +352,7 @@
352352
}
353353
},
354354
"AcsSmsDeliveryReportReceivedEventData": {
355-
"description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.SMSDeliveryReportReceived event.",
355+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.SMSDeliveryReportReceived event.",
356356
"allOf": [
357357
{
358358
"$ref": "#/definitions/AcsSmsEventBaseProperties"
@@ -386,7 +386,7 @@
386386
}
387387
},
388388
"AcsSmsReceivedEventData": {
389-
"description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.SMSReceived event.",
389+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.SMSReceived event.",
390390
"allOf": [
391391
{
392392
"$ref": "#/definitions/AcsSmsEventBaseProperties"
@@ -405,7 +405,7 @@
405405
}
406406
},
407407
"AcsRecordingFileStatusUpdatedEventData": {
408-
"description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.RecordingFileStatusUpdated event.",
408+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RecordingFileStatusUpdated event.",
409409
"properties": {
410410
"recordingStorageInfo": {
411411
"description": "The details of recording storage information",

‎specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/EventGrid.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@
262262
"description": "Properties of an event published to an Event Grid topic using a custom schema"
263263
},
264264
"SubscriptionValidationEventData": {
265-
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.EventGrid.SubscriptionValidationEvent.",
265+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.EventGrid.SubscriptionValidationEvent event.",
266266
"type": "object",
267267
"properties": {
268268
"validationCode": {
@@ -288,7 +288,7 @@
288288
}
289289
},
290290
"SubscriptionDeletedEventData": {
291-
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.EventGrid.SubscriptionDeletedEvent.",
291+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.EventGrid.SubscriptionDeletedEvent event.",
292292
"type": "object",
293293
"properties": {
294294
"eventSubscriptionId": {

‎specification/eventgrid/data-plane/Microsoft.EventHub/stable/2018-01-01/EventHub.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"paths": {},
99
"definitions": {
1010
"EventHubCaptureFileCreatedEventData": {
11-
"description": "Schema of the Data property of an EventGridEvent for an Microsoft.EventHub.CaptureFileCreated event.",
11+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.EventHub.CaptureFileCreated event.",
1212
"type": "object",
1313
"properties": {
1414
"fileurl": {

‎specification/eventgrid/data-plane/Microsoft.KeyVault/stable/2018-01-01/KeyVault.json‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"paths": {},
99
"definitions": {
1010
"KeyVaultCertificateNewVersionCreatedEventData": {
11-
"description": "Schema of the Data property of an EventGridEvent for an CertificateNewVersionCreated event.",
11+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.CertificateNewVersionCreated event.",
1212
"type": "object",
1313
"properties": {
1414
"id": {
@@ -42,7 +42,7 @@
4242
}
4343
},
4444
"KeyVaultCertificateNearExpiryEventData": {
45-
"description": "Schema of the Data property of an EventGridEvent for an CertificateNearExpiry event.",
45+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.CertificateNearExpiry event.",
4646
"type": "object",
4747
"properties": {
4848
"id": {
@@ -76,7 +76,7 @@
7676
}
7777
},
7878
"KeyVaultCertificateExpiredEventData": {
79-
"description": "Schema of the Data property of an EventGridEvent for an CertificateExpired event.",
79+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.CertificateExpired event.",
8080
"type": "object",
8181
"properties": {
8282
"id": {
@@ -110,7 +110,7 @@
110110
}
111111
},
112112
"KeyVaultKeyNewVersionCreatedEventData": {
113-
"description": "Schema of the Data property of an EventGridEvent for an KeyNewVersionCreated event.",
113+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.KeyNewVersionCreated event.",
114114
"type": "object",
115115
"properties": {
116116
"id": {
@@ -144,7 +144,7 @@
144144
}
145145
},
146146
"KeyVaultKeyNearExpiryEventData": {
147-
"description": "Schema of the Data property of an EventGridEvent for an KeyNearExpiry event.",
147+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.KeyNearExpiry event.",
148148
"type": "object",
149149
"properties": {
150150
"id": {
@@ -178,7 +178,7 @@
178178
}
179179
},
180180
"KeyVaultKeyExpiredEventData": {
181-
"description": "Schema of the Data property of an EventGridEvent for an KeyExpired event.",
181+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.KeyExpired event.",
182182
"type": "object",
183183
"properties": {
184184
"id": {
@@ -212,7 +212,7 @@
212212
}
213213
},
214214
"KeyVaultSecretNewVersionCreatedEventData": {
215-
"description": "Schema of the Data property of an EventGridEvent for an SecretNewVersionCreated event.",
215+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.SecretNewVersionCreated event.",
216216
"type": "object",
217217
"properties": {
218218
"id": {
@@ -246,7 +246,7 @@
246246
}
247247
},
248248
"KeyVaultSecretNearExpiryEventData": {
249-
"description": "Schema of the Data property of an EventGridEvent for an SecretNearExpiry event.",
249+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.SecretNearExpiry event.",
250250
"type": "object",
251251
"properties": {
252252
"id": {
@@ -280,7 +280,7 @@
280280
}
281281
},
282282
"KeyVaultSecretExpiredEventData": {
283-
"description": "Schema of the Data property of an EventGridEvent for an SecretExpired event.",
283+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.SecretExpired event.",
284284
"type": "object",
285285
"properties": {
286286
"id": {
@@ -314,7 +314,7 @@
314314
}
315315
},
316316
"KeyVaultVaultAccessPolicyChangedEventData": {
317-
"description": "Schema of the Data property of an EventGridEvent for an VaultAccessPolicyChanged event.",
317+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.VaultAccessPolicyChanged event.",
318318
"type": "object",
319319
"properties": {
320320
"id": {

‎specification/eventgrid/data-plane/Microsoft.MachineLearningServices/stable/2018-01-01/MachineLearningServices.json‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"paths": {},
99
"definitions": {
1010
"MachineLearningServicesModelRegisteredEventData": {
11-
"description": "Schema of the Data property of an EventGridEvent for an Microsoft.MachineLearningServices.ModelRegistered event.",
11+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.ModelRegistered event.",
1212
"type": "object",
1313
"properties": {
1414
"modelName": {
@@ -30,7 +30,7 @@
3030
}
3131
},
3232
"MachineLearningServicesModelDeployedEventData": {
33-
"description": "Schema of the Data property of an EventGridEvent for an Microsoft.MachineLearningServices.ModelDeployed event.",
33+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.ModelDeployed event.",
3434
"type": "object",
3535
"properties": {
3636
"serviceName": {
@@ -56,7 +56,7 @@
5656
}
5757
},
5858
"MachineLearningServicesRunCompletedEventData": {
59-
"description": "Schema of the Data property of an EventGridEvent for an Microsoft.MachineLearningServices.RunCompleted event.",
59+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.RunCompleted event.",
6060
"type": "object",
6161
"properties": {
6262
"experimentId": {
@@ -86,7 +86,7 @@
8686
}
8787
},
8888
"MachineLearningServicesDatasetDriftDetectedEventData": {
89-
"description": "Schema of the Data property of an EventGridEvent for an Microsoft.MachineLearningServices.DatasetDriftDetected event.",
89+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.DatasetDriftDetected event.",
9090
"type": "object",
9191
"properties": {
9292
"dataDriftId": {
@@ -127,7 +127,7 @@
127127
}
128128
},
129129
"MachineLearningServicesRunStatusChangedEventData": {
130-
"description": "Schema of the Data property of an EventGridEvent for an Microsoft.MachineLearningServices.RunStatusChanged event.",
130+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.RunStatusChanged event.",
131131
"type": "object",
132132
"properties": {
133133
"experimentId": {

0 commit comments

Comments
 (0)