Azure / Azure/typespec-azure

TSV validation: require + sync-check service.yaml

Open
#4,828 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 #4825.

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

Add a **TypeSpec validation (TSV)** rule for `service.yaml`:
- **present** for every service
- **schema-valid** against the published JSON Schema
- **in sync** — the version set matches the `@versioned` enum (TypeSpec) and the `readme.md` version set during coexistence

Depends on #4826.

Contributor guide

Open the contributing guide

Research direction

Read the linked RFC and dependency #4826 first, then inspect how TypeSpec validation rules discover each service and how service.yaml is represented against its published JSON Schema. Done means every service has a schema-valid service.yaml whose version set matches the @versioned enum and the readme.md version set during coexistence.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.