Skip to content

Update system events docs #34622

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

Merged
JoshLove-msft merged 2 commits into from
May 16, 2025
Merged

Update system events docs #34622

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
08ae904
Update system events docs
JoshLove-msft May 12, 2025
83dfcf9
Merge branch 'main' into update-system-events-docs
JoshLove-msft May 16, 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
Next Next commit
Update system events docs
  • Loading branch information
@JoshLove-msft
JoshLove-msft committed May 12, 2025
commit 08ae90443167181146df5907d28425fdbd5b6ad1
7 changes: 4 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 @@ -73,9 +73,10 @@ More on `@example` can be found [here](https://typespec.io/docs/standard-library

1) Write your service's system events in TypeSpec.
1) Generate the swagger for your service's system events off of TypeSpec, following the steps below:
- Install TypeSpec `npm install @typespec/compiler`
- Install TypeSpec `npm install -g @typespec/compiler`
- Install the emitter `npm install @azure-tools/typespec-autorest`
- Under `/Azure.Messaging.EventGrid.SystemEvents/`:
- Run `npx tsp compile main.tsp --emit @azure-tools/typespec-autorest`
1) Verify the generated swagger under `/data-plane/Microsoft.EventGrid/2024-01-01/` accurately depicts your system events and commit it.
- Run `tsp compile .`
1) Verify the generated swaggers `/data-plane/Microsoft.EventGrid/2018-01-01/GeneratedSystemEvents.json` and `/data-plane/Microsoft.EventGrid/2024-01-01/GeneratedSystemEvents.json` accurately depicts your system events.
1) Copy the delta from `/data-plane/Microsoft.EventGrid/2018-01-01/GeneratedSystemEvents.json` into your resource provider-specific swagger, e.g. `data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json`. Make any manual adjustments as needed.
1) Final PR must contain the TypeSpec and the Swagger generated from the TypeSpec.
Loading