Azure / Azure/azure-sdk-tools

[Epic][TypeSpec Authoring] Support writing examples in authoring stage

Open
#16,284 0 comments 0 reactions 1 assignee Claimed by @haolingdong-msft View on GitHub
AzSDK Tools Agent Epic
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 1h
Merged PRs (30d)
143

Description

## Overview

This epic tracks work to support writing examples during the TypeSpec authoring stage. The goal is to enable authors to create, validate, and manage API examples (operation request/response samples) as part of authoring their TypeSpec, so examples are correct and available early rather than added later in the pipeline.

## Problem

Today examples are typically authored or generated late in the process, disconnected from the authoring experience. Authors lack first-class support for writing examples alongside their TypeSpec, validating them against the models/operations they describe, and catching mismatches early. This leads to missing, incomplete, or invalid examples surfacing downstream.

## Sub-Issues

- Tracked below as sub-issues.

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.