Added Metadata to chat thread and user level events (#26347)

mbutowicz · jnlycklama · commit 66c27c456c65 · 2023-11-08T12:28:47.000-08:00
* Added Metadata to chat thread and user level events

* Updated examples for each event which has new metadata fields

* Apply suggestions for example user metadata

* Update example metadata

* Fix typo

* Remove description from examples and add additional properties value for metadata dictionary to denote type string

* Updated remaining examples in cloud-events-schema and event-grid-schema

* Removed extra metadata properties
diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json
@@ -964,6 +964,13 @@
             "type": "object"
           }
         },
+        "metadata": {
+          "description": "The thread metadata",
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          }
+        },
         "participants": {
           "description": "The list of properties of participants who are part of the thread",
           "type": "array",
@@ -1060,6 +1067,13 @@
           "format": "date-time",
           "type": "string"
         },
+        "metadata": {
+          "description": "The thread metadata",
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          }
+        },
         "properties": {
           "description": "The updated thread properties",
           "type": "object",
@@ -1093,6 +1107,13 @@
           "additionalProperties": {
             "type": "object"
           }
+        },
+        "metadata": {
+          "description": "The thread metadata",
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          }
         }
       }
     },
@@ -1655,6 +1676,13 @@
         "participantCommunicationIdentifier": {
           "description": "The communication identifier of the user",
           "$ref": "../../../../../communication/data-plane/Common/stable/2021-03-07/common.json#/definitions/CommunicationIdentifierModel"
+        },
+        "metadata": {
+          "description": "The metadata of the user",
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          }
         }
       }
     },
diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_participant_added_to_thread_with_user.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_participant_added_to_thread_with_user.json
@@ -19,6 +19,9 @@
         "communicationUser": {
           "id": "8:acs:0a420b29-555c-4f6b-841e-de8059893bb9_00000008-77c9-8785-1655-373a0d00885f"
         }
+      },
+      "metadata": {
+        "key": "value"
       }
     },
     "recipientCommunicationIdentifier": {
diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_participant_removed_from_thread_with_user.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_participant_removed_from_thread_with_user.json
@@ -19,6 +19,9 @@
         "communicationUser": {
           "id": "8:acs:0a420b29-555c-4f6b-841e-de8059893bb9_00000008-77c9-8785-1655-373a0d00885f"
         }
+      },
+      "metadata": {
+        "key": "value"
       }
     },
     "recipientCommunicationIdentifier": {
diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_created.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_created.json
@@ -22,6 +22,9 @@
           "communicationUser": {
             "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38a0-88f7-084822002453"
           }
+        },
+        "metadata": {
+          "key": "value"
         }
       },
       {
@@ -31,6 +34,10 @@
           "communicationUser": {
             "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38e6-07fd-084822002467"
           }
+        },
+        "metadata": {
+          "key": "value",
+          "description": "A map of data associated with the participant"
         }
       },
       {
@@ -40,6 +47,9 @@
           "communicationUser": {
             "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38f6-83fe-084822002337"
           }
+        },
+        "metadata": {
+          "key": "value"
         }
       },
       {
@@ -49,9 +59,15 @@
           "communicationUser": {
             "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38e3-e1fe-084822002c35"
           }
+        },
+        "metadata": {
+          "key": "value"
         }
       }
     ],
+    "metadata": {
+      "key": "value"
+    },
     "createTime": "2021-02-19T16:31:54.365-08:00",
     "version": 1613781114365,
     "threadId": "19:e07c8ddc5bab4c059ea9f11d29b544b6@thread.v2",
diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_created_withUser.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_created_withUser.json
@@ -33,6 +33,9 @@
           "communicationUser": {
             "id": "8:acs:3d703c91-9657-4b3f-b19c-ef9d53f99710_00000008-576c-286d-e1fe-0848220013b9"
           }
+        },
+        "metadata": {
+          "key": "value"
         }
       },
       {
@@ -42,9 +45,15 @@
           "communicationUser": {
             "id": "8:acs:3d703c91-9657-4b3f-b19c-ef9d53f99710_00000008-576c-289b-07fd-0848220015ea"
           }
+        },
+        "metadata": {
+          "key": "value"
         }
       }
     ],
+    "metadata": {
+      "key": "value"
+    },
     "createTime": "2021-02-18T23:47:26.91Z",
     "version": 1613692046910,
     "recipientId": "8:acs:3d703c91-9657-4b3f-b19c-ef9d53f99710_00000008-576c-286e-84f5-08482200181c",
diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_participant_added.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_participant_added.json
@@ -19,6 +19,9 @@
         "communicationUser": {
           "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38f3-88f7-084822002454"
         }
+      },
+      "metadata": {
+        "key": "value"
       }
     },
     "createTime": "2021-02-19T16:31:54.365-08:00",
diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_participant_removed.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_participant_removed.json
@@ -19,6 +19,9 @@
         "communicationUser": {
           "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38e6-07fd-084822002467"
         }
+      },
+      "metadata": {
+        "key": "value"
       }
     },
     "createTime": "2021-02-19T16:31:54.365-08:00",
diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_properties_updated_per_user.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_properties_updated_per_user.json
@@ -16,6 +16,9 @@
     "properties": {
       "topic": "Communication in Azure"
     },
+    "metadata": {
+      "key": "value"
+    },
     "createTime": "2021-02-19T00:28:25.864Z",
     "version": 1613694508719,
     "recipientId": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-578d-7caf-07fd-084822001724",
diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/chat_participant_added_to_thread_with_user.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/chat_participant_added_to_thread_with_user.json
@@ -17,6 +17,9 @@
         "communicationUser": {
           "id": "8:acs:0a420b29-555c-4f6b-841e-de8059893bb9_00000008-77c9-8785-1655-373a0d00885f"
         }
+      },
+      "metadata": {
+        "key": "value"
       }
     },
     "recipientCommunicationIdentifier": {
diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/chat_participant_removed_from_thread_with_user.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/chat_participant_removed_from_thread_with_user.json
@@ -17,6 +17,9 @@
         "communicationUser": {
           "id": "8:acs:0a420b29-555c-4f6b-841e-de8059893bb9_00000008-77c9-8785-1655-373a0d00885f"
         }
+      },
+      "metadata": {
+        "key": "value"
       }
     },
     "recipientCommunicationIdentifier": {
diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/chat_thread_created.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/chat_thread_created.json
@@ -20,6 +20,9 @@
           "communicationUser": {
             "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38a0-88f7-084822002453"
           }
+        },
+        "metadata": {
+          "key": "value"
         }
       },
       {
@@ -29,6 +32,9 @@
           "communicationUser": {
             "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38e6-07fd-084822002467"
           }
+        },
+        "metadata": {
+          "key": "value"
         }
       },
       {
@@ -38,6 +44,9 @@
           "communicationUser": {
             "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38f6-83fe-084822002337"
           }
+        },
+        "metadata": {
+          "key": "value"
         }
       },
       {
@@ -47,9 +56,15 @@
           "communicationUser": {
             "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38e3-e1fe-084822002c35"
           }
+        },
+        "metadata": {
+          "key": "value"
         }
       }
     ],
+    "metadata": {
+      "key": "value"
+    },
     "createTime": "2021-02-20T00:31:54.365+00:00",
     "version": 1613781114365,
     "threadId": "19:e07c8ddc5bab4c059ea9f11d29b544b6@thread.v2",
diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/chat_thread_created_withUser.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/chat_thread_created_withUser.json
@@ -31,6 +31,9 @@
           "communicationUser": {
             "id": "8:acs:3d703c91-9657-4b3f-b19c-ef9d53f99710_00000008-576c-286d-e1fe-0848220013b9"
           }
+        },
+        "metadata": {
+          "key": "value"
         }
       },
       {
@@ -40,9 +43,15 @@
           "communicationUser": {
             "id": "8:acs:3d703c91-9657-4b3f-b19c-ef9d53f99710_00000008-576c-289b-07fd-0848220015ea"
           }
+        },
+        "metadata": {
+          "key": "value"
         }
       }
     ],
+    "metadata": {
+      "key": "value"
+    },
     "createTime": "2021-02-18T23:47:26.91Z",
     "version": 1613692046910,
     "recipientId": "8:acs:3d703c91-9657-4b3f-b19c-ef9d53f99710_00000008-576c-286e-84f5-08482200181c",
diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/chat_thread_participant_added.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/chat_thread_participant_added.json
@@ -17,6 +17,9 @@
         "communicationUser": {
           "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38f3-88f7-084822002454"
         }
+      },
+      "metadata": {
+        "key": "value"
       }
     },
     "createTime": "2021-02-20T00:31:54.365+00:00",
diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/chat_thread_participant_removed.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/chat_thread_participant_removed.json
@@ -17,6 +17,9 @@
         "communicationUser": {
           "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38e6-07fd-084822002467"
         }
+      },
+      "metadata": {
+        "key": "value"
       }
     },
     "createTime": "2021-02-20T00:31:54.365+00:00",
diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/chat_thread_properties_updated.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/chat_thread_properties_updated.json
@@ -13,6 +13,9 @@
     "properties": {
       "topic": "Talk about new Thread Events in commuication services"
     },
+    "metadata": {
+      "key": "value"
+    },
     "createTime": "2021-02-20T00:00:40.126+00:00",
     "version": 1613779447695,
     "threadId": "19:9e8eefe67b3c470a8187b4c2b00240bc@thread.v2",
diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/chat_thread_properties_updated_per_user.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/chat_thread_properties_updated_per_user.json
@@ -14,6 +14,9 @@
     "properties": {
       "topic": "Communication in Azure"
     },
+    "metadata": {
+      "key": "value"
+    },
     "createTime": "2021-02-19T00:28:25.864Z",
     "version": 1613694508719,
     "recipientId": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-578d-7caf-07fd-084822001724",

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,9 @@`
`19`	`19`	`"communicationUser": {`
`20`	`20`	`"id": "8:acs:0a420b29-555c-4f6b-841e-de8059893bb9_00000008-77c9-8785-1655-373a0d00885f"`
`21`	`21`	`}`
	`22`	`+ },`
	`23`	`+ "metadata": {`
	`24`	`+ "key": "value"`
`22`	`25`	`}`
`23`	`26`	`},`
`24`	`27`	`"recipientCommunicationIdentifier": {`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,9 @@`
`22`	`22`	`"communicationUser": {`
`23`	`23`	`"id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38a0-88f7-084822002453"`
`24`	`24`	`}`
	`25`	`+ },`
	`26`	`+ "metadata": {`
	`27`	`+ "key": "value"`
`25`	`28`	`}`
`26`	`29`	`},`
`27`	`30`	`{`
`@@ -31,6 +34,10 @@`
`31`	`34`	`"communicationUser": {`
`32`	`35`	`"id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38e6-07fd-084822002467"`
`33`	`36`	`}`
	`37`	`+ },`
	`38`	`+ "metadata": {`
	`39`	`+ "key": "value",`
	`40`	`+ "description": "A map of data associated with the participant"`
`34`	`41`	`}`
`35`	`42`	`},`
`36`	`43`	`{`
`@@ -40,6 +47,9 @@`
`40`	`47`	`"communicationUser": {`
`41`	`48`	`"id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38f6-83fe-084822002337"`
`42`	`49`	`}`
	`50`	`+ },`
	`51`	`+ "metadata": {`
	`52`	`+ "key": "value"`
`43`	`53`	`}`
`44`	`54`	`},`
`45`	`55`	`{`
`@@ -49,9 +59,15 @@`
`49`	`59`	`"communicationUser": {`
`50`	`60`	`"id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38e3-e1fe-084822002c35"`
`51`	`61`	`}`
	`62`	`+ },`
	`63`	`+ "metadata": {`
	`64`	`+ "key": "value"`
`52`	`65`	`}`
`53`	`66`	`}`
`54`	`67`	`],`
	`68`	`+ "metadata": {`
	`69`	`+ "key": "value"`
	`70`	`+ },`
`55`	`71`	`"createTime": "2021-02-19T16:31:54.365-08:00",`
`56`	`72`	`"version": 1613781114365,`
`57`	`73`	`"threadId": "19:[email protected]",`
Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,9 @@`
`33`	`33`	`"communicationUser": {`
`34`	`34`	`"id": "8:acs:3d703c91-9657-4b3f-b19c-ef9d53f99710_00000008-576c-286d-e1fe-0848220013b9"`
`35`	`35`	`}`
	`36`	`+ },`
	`37`	`+ "metadata": {`
	`38`	`+ "key": "value"`
`36`	`39`	`}`
`37`	`40`	`},`
`38`	`41`	`{`
`@@ -42,9 +45,15 @@`
`42`	`45`	`"communicationUser": {`
`43`	`46`	`"id": "8:acs:3d703c91-9657-4b3f-b19c-ef9d53f99710_00000008-576c-289b-07fd-0848220015ea"`
`44`	`47`	`}`
	`48`	`+ },`
	`49`	`+ "metadata": {`
	`50`	`+ "key": "value"`
`45`	`51`	`}`
`46`	`52`	`}`
`47`	`53`	`],`
	`54`	`+ "metadata": {`
	`55`	`+ "key": "value"`
	`56`	`+ },`
`48`	`57`	`"createTime": "2021-02-18T23:47:26.91Z",`
`49`	`58`	`"version": 1613692046910,`
`50`	`59`	`"recipientId": "8:acs:3d703c91-9657-4b3f-b19c-ef9d53f99710_00000008-576c-286e-84f5-08482200181c",`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,9 @@`
`17`	`17`	`"communicationUser": {`
`18`	`18`	`"id": "8:acs:0a420b29-555c-4f6b-841e-de8059893bb9_00000008-77c9-8785-1655-373a0d00885f"`
`19`	`19`	`}`
	`20`	`+ },`
	`21`	`+ "metadata": {`
	`22`	`+ "key": "value"`
`20`	`23`	`}`
`21`	`24`	`},`
`22`	`25`	`"recipientCommunicationIdentifier": {`