Support XML serialization in http-client-java generator by weidongxu-microsoft · Pull Request #11305 · microsoft/typespec

weidongxu-microsoft · 2026-07-20T04:55:15Z

Summary

Adds XML serialization support to the @typespec/http-client-java generator (azure-core v1 flavor).

When any model is serialized/deserialized as XML, the generator now:

Emits two helper classes into the implementation package — XmlSerializer (an ObjectSerializer backed by azure-xml + reflective fromXml(XmlReader)) and XmlSerializerProviders (factory). Emission is gated on isAzureV1() and any generating model with ClientModel::isUsedInXml.
Uses the XML serializer overload in generated convenience methods — a static SERIALIZER field is declared on sync/async convenience clients, and BinaryData.fromObject(input, SERIALIZER) / toObject(X.class, SERIALIZER) are emitted when the request/response content type is XML.

The azure-v2 / clientcore flavor handles XmlSerializable natively and is unaffected. Non-XML output is unchanged.

Changes

Generator core: new resource templates XmlSerializer.java / XmlSerializerProviders.java; XML-aware SupportedMimeType handling in ConvenienceMethodTemplateBase, ConvenienceSyncMethodTemplate, ConvenienceAsyncMethodTemplate; static SERIALIZER field in ServiceSyncClientTemplate / ServiceAsyncClientTemplate; constants in ClientModelUtil.
Generator plugin: TypeSpecPlugin.writeHelperClasses emits the two helper files for XML models.
Test module: enabled the payload/xml spec, regenerated clients, and ported the XML test suite.

Testing

payload.xml.XmlTests: 26 run, 0 failures, 2 skipped (namespace scenarios).
Verified end-to-end: generator rebuild → emitter pack → tsp compile → generated output adopted into src matches, tests green.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: a10e9989-905e-4380-a221-01c04f4da1f7

Add XmlSerializer/XmlSerializerProviders in the implementation package and route the toObject/fromObject convenience methods through the XML serializer overload so XML clients serialize XML instead of JSON. Add jackson-dataformat-xml for error-body decoding. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: a10e9989-905e-4380-a221-01c04f4da1f7

… models Emit XmlSerializer and XmlSerializerProviders implementation classes from the generator when any generating model is used in XML (azure-v1 flavor). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: a10e9989-905e-4380-a221-01c04f4da1f7

…enience methods Convenience method templates now declare a static XML ObjectSerializer and use the toObject/fromObject(serializer) overloads when the request/response content type is XML (azure-core v1 flavor). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: a10e9989-905e-4380-a221-01c04f4da1f7

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: a10e9989-905e-4380-a221-01c04f4da1f7

github-actions · 2026-07-20T04:57:50Z

All changed packages have been documented.

✅ @typespec/http-client-java

Show changes

`@typespec/http-client-java` - feature ✏️

Support XML serialization for models: generate XmlSerializer helper classes and use the XML ObjectSerializer overload of toObject/fromObject in convenience methods for XML request/response bodies.

azure-sdk-automation · 2026-07-20T05:08:00Z

You can try these changes here

🛝 Playground	🌐 Website	🛝 VSCode Extension

…t-java Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: a10e9989-905e-4380-a221-01c04f4da1f7

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: a10e9989-905e-4380-a221-01c04f4da1f7

…nt template Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: a10e9989-905e-4380-a221-01c04f4da1f7

weidongxu-microsoft · 2026-07-20T06:12:04Z

fix #11306

… files Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: a10e9989-905e-4380-a221-01c04f4da1f7

Copilot

Copilot wasn't able to review this pull request because it exceeds the maximum number of lines (20,000). Try reducing the number of changed lines and requesting a review from Copilot again.

XiaofeiCao

Haven't dive deep into the codegen. Generated models looks good.

- Update core-commit.json to microsoft/typespec d012e83 (XML serialization, microsoft/typespec#11305). - Sync emitter test src/tsp via SyncTests.ps1. - Generate.ps1: skip payload/xml via the generateScript filter (early return, matching core's skip pattern) instead of Remove-Item on the specs folder. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: cd6f2e08-d6d3-42ae-affd-bc71e98086f7

- Update core-commit.json to microsoft/typespec d012e83 (XML serialization, microsoft/typespec#11305). - Sync emitter test src/tsp via SyncTests.ps1 (adds payload/xml XmlTests). - Generate.ps1: stop removing the payload/xml specs folder so xml is generated, matching core (which no longer skips xml). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: cd6f2e08-d6d3-42ae-affd-bc71e98086f7

## Summary - Update `packages/typespec-java/core-commit.json` to microsoft/typespec [d012e83](microsoft/typespec@d012e83) (Support XML serialization in http-client-java generator, microsoft/typespec#11305). - Sync emitter test `src`/`tsp` from core via `SyncTests.ps1` (adds `emitter-tests/src/test/java/payload/xml` XmlTests). - `emitter-tests/Generate.ps1`: stop removing `payload/xml` specs now that the emitter supports XML models. - Add chronus changelog entry (fix) mirroring the upstream XML serialization change. --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

weidongxu-microsoft added 7 commits July 20, 2026 11:20

enable tests for xml

b07240a

regen

82c7cad

test: port XML payload tests to http-client-generator-test

a1fbd84

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: a10e9989-905e-4380-a221-01c04f4da1f7

chore: add changelog entry for XML serialization support

6d30315

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: a10e9989-905e-4380-a221-01c04f4da1f7

microsoft-github-policy-service Bot added the emitter:client:java Issue for the Java client emitter: @typespec/http-client-java label Jul 20, 2026

docs: document emitter/generator e2e code-gen workflow for http-clien…

2590cb4

…t-java Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: a10e9989-905e-4380-a221-01c04f4da1f7

microsoft-github-policy-service Bot added the eng label Jul 20, 2026

weidongxu-microsoft and others added 3 commits July 20, 2026 13:23

docs: use mvn --define long-form flags to satisfy spellcheck

52f65c4

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: a10e9989-905e-4380-a221-01c04f4da1f7

format

ac56a37

Address review feedback: consistent XML serializer check in sync clie…

733e444

…nt template Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: a10e9989-905e-4380-a221-01c04f4da1f7

weidongxu-microsoft force-pushed the http-client-java_dpg-xml branch from 128b933 to 733e444 Compare July 20, 2026 05:49

weidongxu-microsoft marked this pull request as ready for review July 20, 2026 06:23

weidongxu-microsoft requested review from XiaofeiCao, alzimmermsft and haolingdong-msft as code owners July 20, 2026 06:23

Update payload-xml metadata to include generated XmlSerializer helper…

edd58f1

… files Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: a10e9989-905e-4380-a221-01c04f4da1f7

weidongxu-microsoft requested a review from Copilot July 20, 2026 09:15

Copilot started reviewing on behalf of weidongxu-microsoft July 20, 2026 09:15 View session

Copilot AI reviewed Jul 20, 2026

XiaofeiCao approved these changes Jul 21, 2026

View reviewed changes

weidongxu-microsoft added this pull request to the merge queue Jul 21, 2026

Merged via the queue into microsoft:main with commit d012e83 Jul 21, 2026
43 checks passed

weidongxu-microsoft deleted the http-client-java_dpg-xml branch July 21, 2026 04:28

weidongxu-microsoft mentioned this pull request Jul 21, 2026

Sync typespec-java core: support XML serialization Azure/typespec-azure#4987

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Support XML serialization in http-client-java generator#11305

Support XML serialization in http-client-java generator#11305
weidongxu-microsoft merged 12 commits into
microsoft:mainfrom
weidongxu-microsoft:http-client-java_dpg-xml

weidongxu-microsoft commented Jul 20, 2026

Uh oh!

github-actions Bot commented Jul 20, 2026

`@typespec/http-client-java` - feature ✏️

Uh oh!

azure-sdk-automation Bot commented Jul 20, 2026 •

edited

Loading

Uh oh!

weidongxu-microsoft commented Jul 20, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

XiaofeiCao left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

weidongxu-microsoft commented Jul 20, 2026

Summary

Changes

Testing

Uh oh!

github-actions Bot commented Jul 20, 2026

@typespec/http-client-java - feature ✏️

Uh oh!

azure-sdk-automation Bot commented Jul 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

weidongxu-microsoft commented Jul 20, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

XiaofeiCao left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

`@typespec/http-client-java` - feature ✏️

azure-sdk-automation Bot commented Jul 20, 2026 •

edited

Loading