Repository navigation
Preserve example payload order during migration - #5811
Merged
Timothee Guerin (timotheeguerin) merged 1 commit intoOct 22, 2026
Merged
Timothee Guerin (timotheeguerin) merged 1 commit into
Timothee Guerin (timotheeguerin) merged 1 commit into
Conversation
Contributor
|
❌ There is undocummented changes. Run The following packages have changes but are not documented.
The following packages have already been documented:
Show changes
|
Timothee Guerin (timotheeguerin)
marked this pull request as ready for review
October 22, 2026 13:04
Timothee Guerin (timotheeguerin)
requested review from
Mark Cowlishaw (markcowl) and
Jeff Fisher (xirzec)
as code owners
October 22, 2026 13:04
Contributor
📦 Package size report✅ No notable package size changes compared to the base branch. 14 package(s) with no notable change
Packed = gzipped |
commit: |
Contributor
|
You can try these changes here
|
iscai-msft
approved these changes
Oct 22, 2026
Timothee Guerin (timotheeguerin)
merged commit Oct 22, 2026
fa93e0e
into
Azure:release/october-2026
44 checks passed
Timothee Guerin (timotheeguerin)
deleted the
fix/examples-payload-order
branch
October 22, 2026 16:50
Timothee Guerin (timotheeguerin)
added a commit
that referenced
this pull request
Oct 22, 2026
…r locations (#5799) Unified examples can currently validate successfully even when values do not match the API, and a misspelled operation can silently lose its example during compilation. `tsp-examples validate <project>` now compiles the current TypeSpec/AutoRest HTTP contract **in memory** and checks request/response values, including required and typed server parameters, with the existing JSON Schema validator. Errors include the API version, offending value path, and YAML location. No generated files are overwritten. Unknown applicable operation keys are errors during both validation and AutoRest compilation. External Swagger parameter references are resolved before migrating locations or expanding body parameter names, eliminating the manual path-parameter repairs needed by every ARM pilot. **Command behavior change:** API validation requires `main.tsp` and the project's installed compiler/AutoRest emitter. Use `--schema-only` for format-only folders or the previous check. The pure/browser validation APIs remain format-only and unchanged. Fixes #5793, #5795, and #5796. Payload-order preservation is isolated in #5811 so it can be reviewed and released independently. Targets `release/october-2026`; contributor documentation is kept off the release branch. Strict validation exposes pre-existing pilot data issues: Commerce's string-valued `showDetails`, Community Training's undeclared LRO header, and Schema Registry's server parameter name and undeclared response header. These need explicit data/API repairs rather than silently rewriting examples. --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Timothee Guerin (timotheeguerin)
added a commit
that referenced
this pull request
Oct 22, 2026
The unified-example fixes are merged but not yet available in the October packages. Prepare these patch releases from `release/october-2026`: | Package | Version | | --- | --- | | `@azure-tools/typespec-autorest` | `0.73.1` → `0.73.2` | | `@azure-tools/typespec-azure-examples` | `0.2.1` → `0.2.2` | Ships #5799 and #5811: API-aware validation, unknown-operation errors, referenced parameter locations, and payload-order preservation. `tsp-examples validate` now checks API compatibility by default; `--schema-only` retains the previous format-only check. Release metadata only. SDK reader release/adoption is separate. After publishing, backmerge the release branch into `main`. --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Migrating examples should not shuffle payload fields in the generated JSON. Deduplication currently collapses versions whose values match but whose field order differs, and response mapping always puts headers before the body.
Preserve the original request/response payload order, including nested objects and array items, and keep a
sincevariant when only ordering changes. No YAML metadata, schema changes, or dependencies are added.This is the standalone ordering fix, separated from #5799. Targets
release/october-2026.