Skip to content

Commit

Permalink
Add a note to Event Grid readme about review (#21968)
Browse files Browse the repository at this point in the history
* Add a note to Event Grid readme about review

* Update specification/eventgrid/data-plane/readme.md

Co-authored-by: Laurent Mazuel <[email protected]>

Co-authored-by: Laurent Mazuel <[email protected]>
  • Loading branch information
JoshLove-msft and lmazuel authored Dec 22, 2022
1 parent 1c872e2 commit 65f5099
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions specification/eventgrid/data-plane/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 65f5099

Please sign in to comment.