Skip to content

Migrate all services to examples.yaml #4839

Description

@timotheeguerin

Part of #4831.

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

Roll the examples migration out across all remaining services after the EventGrid pilot (#4838) proves the flow.

Scope

  • Run examples-migrate (examples-migrate tool #4833) for every service to produce examples.yaml (dedup into since variants, {api-version} normalization).
  • Validate each with examples-validate (examples.yaml JSON Schema + examples-validate #4832) and confirm per-version round-trip against the original x-ms-examples.
  • Stage the migration service-by-service (or in batches) to keep PRs reviewable.
  • Enforce in CI that new/updated examples use the new format once a service is migrated.
  • Track and remediate services that need manual attention (unusual x-ms-examples, non-ARM URL shapes, etc.).

Out of scope

Depends on #4838 (EventGrid pilot + CI round-trip).

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions