Azure / Azure/typespec-azure

Auxiliary tooling: examples-scaffold + examples-diff

Open
#4,837 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

Auxiliary example tooling.

### Scope
- **`examples-scaffold`** — generate faked initial examples from the API surface, **replacing OAV's faked-example generation**.
- **`examples-diff`** — show what changed in an example between versions.

Depends on #4832 (schema).

Contributor guide

Open the contributing guide

Research direction

Start by reading the unified examples RFC at documentation/rfc/unified-examples-format/rfc and inspect dependency #4832 for the schema. Then trace OAV's faked-example generation to understand what examples-scaffold replaces. Done means the scaffold and diff tooling described in the scope are implemented against the agreed schema.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.