Azure / Azure/typespec-azure

Pilot migration (EventGrid) + CI round-trip

Open
#4,838 0 comments 0 reactions 0 assignees View on GitHub
eng feature triaged:core
Dominant language
TypeScript
Stars
27
Forks
90
Avg merge
1d 22h
Merged PRs (30d)
156

Description

Part of #4831.

RFC: https://github.com/Azure/azure-rest-api-specs/blob/rfc/unified-examples-format/documentation/rfc/unified-examples-format.md

**Pilot the full flow on EventGrid** before broad rollout.

### Scope
- Migrate EventGrid's `x-ms-examples` to a single `examples.yaml` using `examples-migrate`.
- Validate with `examples-validate`; emit `x-id` (#4835) and resolve per version (#4834).
- Wire **CI round-trip validation**: materialized examples for each version match the original `x-ms-examples` (for migrated versions).

Depends on #4832, #4833, #4834, #4835.

Contributor guide

Open the contributing guide

Research direction

Read the unified examples RFC and the prerequisite issues #4832, #4833, #4834, and #4835 first. Use EventGrid as the pilot with examples-migrate and examples-validate, then trace the CI workflow that can compare materialized examples for each version with the original x-ms-examples. Done means the migration validates, x-id and per-version resolution work, and the CI round-trip passes.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure, typescript
Domain
ci-cd, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.