Skip to content

Commit 90041e3

Browse files
Update system events docs (#34622)
1 parent 9cc4853 commit 90041e3

File tree

1 file changed

+4
-3
lines changed
  • specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents

1 file changed

+4
-3
lines changed

specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,10 @@ More on `@example` can be found [here](https://typespec.io/docs/standard-library
7373

7474
1) Write your service's system events in TypeSpec.
7575
1) Generate the swagger for your service's system events off of TypeSpec, following the steps below:
76-
- Install TypeSpec `npm install @typespec/compiler`
76+
- Install TypeSpec `npm install -g @typespec/compiler`
7777
- Install the emitter `npm install @azure-tools/typespec-autorest`
7878
- Under `/Azure.Messaging.EventGrid.SystemEvents/`:
79-
- Run `npx tsp compile main.tsp --emit @azure-tools/typespec-autorest`
80-
1) Verify the generated swagger under `/data-plane/Microsoft.EventGrid/2024-01-01/` accurately depicts your system events and commit it.
79+
- Run `tsp compile .`
80+
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.
81+
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.
8182
1) Final PR must contain the TypeSpec and the Swagger generated from the TypeSpec.

0 commit comments

Comments
 (0)