Azure / Azure/typespec-azure

[Epic/Design]: Identify and fix or remove Swagger Breaking Change Rules for TypeSpec specs

Open
#36 1 comment 0 reactions 0 assignees View on GitHub
epic
Dominant language
TypeScript
Stars
27
Forks
90
Avg merge
1d 22h
Merged PRs (30d)
156

Description

related to: https://github.com/Azure/typespec-azure/issues/35

- Many breaking change rules apply to the names of elements of the spec that do not impact the API on the wire, but do impact client generation. Need a way to reflect a change in client name in a way that turnes off these rules
- DPG decorators used in swagger generation (e.g. x-ms-client-name)
- Linting rules are altered to be aware of x-ms-client-name in areas where they are not
- Alternately, DPG decorators add suppressions for breaking change rules (where inline suppressions are allowed)
- Other breaking change rules are irrelevant and should be removed
- MissingParameters mistakenly marking method parameters not appearing in the global parameters section
- PUT/PATCH violations for PATCH model not including mutability

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.