Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[eg] make req/optional more explicit in readme #32079

Merged
merged 2 commits into from
Jan 10, 2025
Merged

[eg] make req/optional more explicit in readme #32079

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
24af321
update
l0lawrence Jan 9, 2025
f373c0a
update for clarity
l0lawrence Jan 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,18 @@ In order to automate the mapping of event definition with event type, please fol

Under the `Azure.Messaging.EventGrid.SystemEvents` folder find or create your service's `.tsp` file. This is where you will add your new event. For help with typespec conventions refer to [this doc](https://microsoft.github.io/typespec/) about typespec basics. Each new event will be represented as a typespec `model`. After you create your new event, in the `client.tsp` file, you need to add `@@usage(EventGrid.YourEventName, Usage.output)` and `@@access(EventGrid.YourEventName, Access.public)`.

A sample valid event definition is shown below:
A sample valid event definition is shown below with `required` and `optional` properties:
~~~ markdown

/** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageReceived event. */
model AcsChatMessageReceivedEventData {
...AcsChatMessageEventBaseProperties;

/** The body of the chat message. */
messageBody : string;
/** Required. Field is always present in the event. */
requiredProperty : string;

/** Optional. Field may not be present in some events. */
optionalProperty ?: string;
}
~~~

Expand Down
Loading