Skip to content

[Swagger Linter Migration] MissingXmsErrorResponse -> require-error-decorator - #6028

Open
Mary Gao (MaryGao) wants to merge 2 commits into
mainfrom
feat/missing-xms-error-response-6014
Open

Mary Gao (MaryGao) wants to merge 2 commits into
mainfrom
feat/missing-xms-error-response-6014

Conversation

@MaryGao

@MaryGao Mary Gao (MaryGao) commented Nov 9, 2026 •

Copy link
Copy Markdown
Member

Original Swagger linter

Migration report

migration.md

Historical full validation (74e56a0): 487/487 ARM projects passed native validation, matching all 20 historical Swagger findings with 0 Swagger-only and 6 explained native-only findings; final integrity verification passed and the full report is published (details).

Fixes #6014

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@microsoft-github-policy-service microsoft-github-policy-service Bot added int:azure-specs Run integration tests against azure-rest-api-specs lib:azure-resource-manager Issues for @azure-tools/typespec-azure-core library meta:website TypeSpec.io updates linter Issues related to linter rules labels Nov 9, 2026
@github-actions

github-actions Bot commented Nov 9, 2026 •

Copy link
Copy Markdown
Contributor

All changed packages have been documented.

  • ✅ @azure-tools/typespec-azure-resource-manager
  • ✅ @azure-tools/typespec-azure-rulesets
Show changes

@azure-tools/typespec-azure-rulesets - internal ✏️

Register require-error-decorator as disabled in the resource-manager recommended ruleset.

@azure-tools/typespec-azure-resource-manager - feature ✏️

Add require-error-decorator to require @error on 4xx and 5xx response models, except HEAD 404 responses.

@github-actions

github-actions Bot commented Nov 9, 2026 •

Copy link
Copy Markdown
Contributor

📦 Package size report

✅ No notable package size changes compared to the base branch.

14 package(s) with no notable change
Package Packed (base → head) Δ Packed Unpacked (base → head) Δ Unpacked
@azure-tools/typespec-azure-resource-manager 211.13 KB → 211.22 KB +91 B (+0.0%) 1.26 MB → 1.26 MB +638 B (+0.0%)
@azure-tools/typespec-azure-rulesets 6.21 KB → 6.23 KB +24 B (+0.4%) 38.47 KB → 38.67 KB +197 B (+0.5%)
@azure-tools/azure-http-specs 154.49 KB → 154.49 KB — 1.27 MB → 1.27 MB —
@azure-tools/typespec-autorest 88.64 KB → 88.64 KB — 427.94 KB → 427.94 KB —
@azure-tools/typespec-autorest-canonical 7.42 KB → 7.42 KB — 26.00 KB → 26.00 KB —
@azure-tools/typespec-azure-core 144.66 KB → 144.66 KB — 771.39 KB → 771.39 KB —
@azure-tools/typespec-azure-examples 96.99 KB → 96.99 KB — 487.04 KB → 487.04 KB —
@azure-tools/typespec-azure-portal-core 36.32 KB → 36.32 KB — 243.05 KB → 243.05 KB —
@azure-tools/typespec-client-generator-core 264.53 KB → 264.53 KB — 1.40 MB → 1.40 MB —
@azure-tools/typespec-go 303.20 KB → 303.20 KB — 1.55 MB → 1.55 MB —
@azure-tools/typespec-java 20.23 MB → 20.23 MB — 22.53 MB → 22.53 MB —
@azure-tools/typespec-metadata 15.88 KB → 15.88 KB — 62.08 KB → 62.08 KB —
@azure-tools/typespec-python 42.66 KB → 42.66 KB — 166.15 KB → 166.15 KB —
@azure-tools/typespec-ts 551.21 KB → 551.21 KB — 2.76 MB → 2.76 MB —

Packed = gzipped .tgz published to npm. Unpacked = total extracted size. 🆕 added, 🗑️ removed. Packages from the core/ submodule are not included.
🔴 grew · 🟢 shrank — only changes of at least 512 B and 0.5% are marked.

@pkg-pr-new

pkg-pr-new Bot commented Nov 9, 2026 •

Copy link
Copy Markdown

Open in StackBlitz

npm i https://pkg.pr.new/@azure-tools/typespec-azure-resource-manager@6028
npm i https://pkg.pr.new/@azure-tools/typespec-azure-rulesets@6028

commit: 1ace718

@azure-sdk-automation

Copy link
Copy Markdown
Contributor

You can try these changes here

🛝 Playground 🌐 Website

@MaryGao

Mary Gao (MaryGao) commented Nov 10, 2026 •

Copy link
Copy Markdown
Member Author

Full ARM validation is complete for MissingXmsErrorResponse → missing-error-decorator, including final dataset integrity verification.

  • 487/487 projects assessed successfully, with no compile/worker failures.
  • 20 Swagger findings matched, 0 Swagger-only, 6 explained native-only.
  • Extras: four non-service Search SDK customizations, one CSharp-only Deployment Stacks customization excluded by AutoRest scope, and one Solutions response under x-ms-paths outside the legacy selector.

Fresh native source-scope lint used the verified historical Swagger baseline at specs revision 2cd3c5dd6d00a5f53214fe594afd2aef3f44d3f9 and unchanged candidate 74e56a0f144190769180d5dbb27179db8b448c9c. Swagger was not regenerated; source suppressions were retained and the target rule was explicitly enabled. Source/version populations are not aligned, so observed correspondence is not a universal equivalence claim.

Full report and published evidence. All 487 native receipts and exact runtime artifacts are preserved; the uploaded runtime archive passed a download/hash round trip. CI/reviewer approval remains separate.

@MaryGao Mary Gao (MaryGao) changed the title Imple MissingXmsErrorResponse rule [Swagger Linter Migration] MissingXmsErrorResponse -> missing-error-decorator Nov 10, 2026
@MaryGao
Mary Gao (MaryGao) marked this pull request as ready for review November 10, 2026 09:18
Rename the rule to require-error-decorator and simplify documentation examples while preserving new upstream rule registrations.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@MaryGao Mary Gao (MaryGao) changed the title [Swagger Linter Migration] MissingXmsErrorResponse -> missing-error-decorator [Swagger Linter Migration] MissingXmsErrorResponse -> require-error-decorator Nov 11, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

int:azure-specs Run integration tests against azure-rest-api-specs lib:azure-resource-manager Issues for @azure-tools/typespec-azure-core library linter Issues related to linter rules meta:website TypeSpec.io updates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Support swagger linter rule MissingXmsErrorResponse in typespec

2 participants