microsoft / microsoft/typespec

[Bug]: @opExample ignores/incorrectly represent @renamedFrom and @typeChangedFrom under versioning

Open
#10,572 1 comment 0 reactions 1 assignee Claimed by @markcowl View on GitHub
bug needs-area triaged:core
Dominant language
Java
Stars
5.9k
Forks
394
Avg merge
1d 23h
Merged PRs (30d)
104

Description

### Describe the bug

When using `@opExample` together with TypeSpec versioning, decorators like `@renamedFrom` and `@typeChangedFrom` are not respected when generating examples.

The example payload appears to only consider the **latest version of the model**, instead of applying version transformations. As a result, version-specific fields (renamed or type-changed) are ignored or incorrectly represented in the generated OpenAPI examples.

### Reproduction

Reproducible playground example:
https://typespec.io/playground/?options=%7B%22linterRuleSet%22%3A%7B%22extends%22%3A%5B%22%40typespec%2Fhttp%2Fall%22%5D%7D%7D&e=%40typespec%2Fopenapi3&vs=%7B%7D&c=aW1wb3J0ICJAdHlwZXNwZWMvaHR0cCI7CtIZdmVyc2lvbmluZyI7Cgp1c2luZyBIdHRwO8cMVskgOwoKQMcuZWQoxxhzKQpAc2VydmljZSgjeyB0aXRsZTogIldpZGdldCBTxhoiIH0pCm5hbWVzcGFjZSBEZW1vxxo7CgoKZW51bchncyB7CiAgdjEsxAYyLAp9Cgptb2RlbCDHUcQed2VpZ2h0OiBpbnQzMjsKICBjb2xvcjogInJlZCIgfCAiYmx1ZSLEGQogIEByZW1vdusAsC52MikKICDkAI46IHN0cuUA2SAgLy8gSWRlYWxseSBJIHdvdWxkIGhhdmUgdXNlZMRFxDBkRnJvbcxJLCAid%2BUAmFZhxHPEWC8vIGluc3RlYWQgb2YgQGFkZGVkIGFuxUTlAIkgd2l0aCAyIGRpZmZlcmVudCBmaWVsZHMgdG8gZGVmaW5lIMVuaW5n5AC%2FxUHMdMRldsRv7AC%2B%2BADm6wCeyi8K2VhrZXnLJ%2BUAzVRoZeYAoSB3YXPmAXMgaW4gdjHlANVub3cgY2hhbmdl5QDAxjvFIDIu5AF%2Bx0FleGFtcGxlIEkgY2Fu6ADmaXMgYXMgcGVyIHYyIOYCbMZAxjhCdXQgdGhlbsQFyUF0cmFuc2xhdGVkxWUxxUVsc28gbWFwcOQBaXPHRCB3aGVyZWFzxT7mAMDkAvLEMOkAxHNjaGVtYeQBDcQbQ%2BUAx%2FMB48Uw5AEexUfqASB9CgpAcm91dGUoIi%2FmAWhzIikKQHRhZyjnAv%2FEEGludGVyZuQC9scU5QLDLyoqIENyZWF0ZSBh5wGlICov5ACLb3BF5gDsKCN7cGFyYW1ldGVyczogI3vGJ8QK5wCJIjEwIizuAeMid3YxIizmAcgia8QL5wIrIjIiLOcC9CJ3xAzoAzTlAyws6QNUMTB9fX3kAO3kAIxwb3N0IGPlAKcoQGJvZHnHbTrnAMwpyAnkAQ0%3D

### Checklist

- [x] Follow our [Code of Conduct](https://github.com/microsoft/typespec/blob/main/CODE_OF_CONDUCT.md)
- [x] Check that there isn't already an issue that request the same bug to avoid creating a duplicate.
- [x] Check that this is a concrete bug. For Q&A open a [GitHub Discussion](https://github.com/Microsoft/typespec/discussions).
- [x] The provided reproduction is a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) of the bug.

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.