From 65f5099082a02703fbca8c9863940ea83cdf0bb7 Mon Sep 17 00:00:00 2001 From: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com> Date: Thu, 22 Dec 2022 14:35:55 -0800 Subject: [PATCH] Add a note to Event Grid readme about review (#21968) * Add a note to Event Grid readme about review * Update specification/eventgrid/data-plane/readme.md Co-authored-by: Laurent Mazuel Co-authored-by: Laurent Mazuel --- specification/eventgrid/data-plane/readme.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/specification/eventgrid/data-plane/readme.md b/specification/eventgrid/data-plane/readme.md index 3b09e766c23f..43dfa756df00 100644 --- a/specification/eventgrid/data-plane/readme.md +++ b/specification/eventgrid/data-plane/readme.md @@ -14,6 +14,8 @@ This enables customers to download one EventGrid data plane library instead of h ### Guidelines for defining a new event +> **_NOTE:_** New events must not be delivered to Event Grid production endpoints until the events have been reviewed with the Azure SDK Architecture board and the PR is merged into main. + In order to automate the mapping of event definition with event type, please follow the guidelines below when adding new events to your swagger: - The name of a new event definition should have `EventData` suffix. For e.g. `AcsChatMessageReceivedEventData`. - The description of the new event should include the event type. This is the `eventType` name in an `EventGridEvent` or `type` name in `CloudEvent`. For e.g. `"Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageReceived event.` Here `Microsoft.Communication.ChatMessageReceived` is the event name.