Azure / Azure/typespec-azure

TCGC + consumers adoption of `examples.yaml`

Open
#4,836 0 comments 0 reactions 1 assignee Claimed by @tadelesh View on GitHub
feature lib:tcgc
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

Adopt the new examples format in the **consumers**.

### Scope
- **TCGC** parses `examples.yaml` and surfaces real example content (all language generators consume examples via TCGC, so TCGC must adopt the format).
- **SDK test generation** consumes resolved examples (via `examples-resolve`) to generate test cases.
- Join Swagger operations to examples via **`x-id`** rather than embedded `$ref`.

Depends on #4834 (resolve) and #4835 (`x-id` emission).

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.