[http-client-java] Document protocol response headers

[Weidong Xu (weidongxu-microsoft)]

Summary

• Document successful response headers in protocol API Javadocs for methods with RequestOptions
• Preserve response-header client type and description metadata on proxy methods
• Regenerate the existing datetime and typed response-header fixtures

Testing

• Java emitter build and formatting
• Java emitter lint
• Existing datetime and response-header tests

Fixes Azure/autorest.java#2297

[github-actions]

All changed packages have been documented.

• ✅ @typespec/http-client-java

Show changes

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

Document response headers in protocol API Javadocs.

[azure-sdk-automation]

You can try these changes here

🛝 Playground	🌐 Website	🛝 VSCode Extension

[Copilot]

Pull request overview

Adds response-header metadata to Java protocol API Javadocs, addressing Azure/autorest.java#2297.

Changes:

• Models response-header names, types, and descriptions on proxy methods.
• Generates response-header Javadoc tables for RequestOptions methods.
• Regenerates affected Java fixtures and adds a changelog entry.

Reviewed changes

Copilot reviewed 41 out of 41 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
type/file/implementation/BodiesImpl.java	Regenerates file-operation header docs.
type/file/FileClient.java	Adds synchronous file response-header docs.
type/file/FileAsyncClient.java	Adds asynchronous file response-header docs.
tsptest/specialheaders/RepeatabilityHeadersClient.java	Documents repeatability headers.
tsptest/specialheaders/RepeatabilityHeadersAsyncClient.java	Documents async repeatability headers.
tsptest/specialheaders/implementation/RepeatabilityHeadersImpl.java	Regenerates implementation Javadocs.
tsptest/specialheaders/implementation/EtagHeadersImpl.java	Documents implementation ETag headers.
tsptest/specialheaders/EtagHeadersClient.java	Documents synchronous ETag headers.
tsptest/specialheaders/EtagHeadersAsyncClient.java	Documents asynchronous ETag headers.
tsptest/responseheaders/ResponseHeadersClient.java	Documents typed response headers.
tsptest/responseheaders/ResponseHeadersAsyncClient.java	Documents async typed headers.
tsptest/responseheaders/implementation/ResponseHeaderOpsImpl.java	Regenerates typed-header implementation docs.
tsptest/response/ResponseClient.java	Documents operation-location headers.
tsptest/response/ResponseAsyncClient.java	Documents async operation-location headers.
tsptest/response/implementation/ResponseClientImpl.java	Regenerates response implementation docs.
tsptest/optional/OptionalClient.java	Documents optional response headers.
tsptest/optional/OptionalAsyncClient.java	Documents async optional headers.
tsptest/optional/implementation/OptionalOpsImpl.java	Regenerates optional-operation docs.
tsptest/longrunning/LongRunningClient.java	Documents LRO retry headers.
tsptest/longrunning/LongRunningAsyncClient.java	Documents async LRO retry headers.
tsptest/longrunning/implementation/LongRunningClientImpl.java	Regenerates LRO implementation docs.
specialheaders/repeatability/RepeatabilityClient.java	Documents repeatability results.
specialheaders/repeatability/RepeatabilityAsyncClient.java	Documents async repeatability results.
specialheaders/repeatability/implementation/RepeatabilityClientImpl.java	Regenerates repeatability implementation docs.
payload/head/implementation/HeadClientImpl.java	Documents HEAD response headers.
payload/head/HeadClient.java	Documents synchronous HEAD headers.
payload/head/HeadAsyncClient.java	Documents asynchronous HEAD headers.
encode/datetime/ResponseHeaderClient.java	Documents datetime response headers.
encode/datetime/ResponseHeaderAsyncClient.java	Documents async datetime headers.
encode/datetime/implementation/ResponseHeadersImpl.java	Regenerates datetime implementation docs.
client/naming/implementation/HeadersImpl.java	Documents renamed response headers.
client/naming/HeaderClient.java	Documents synchronous renamed headers.
client/naming/HeaderAsyncClient.java	Documents asynchronous renamed headers.
azure/core/traits/TraitsClient.java	Documents trait response headers.
azure/core/traits/TraitsAsyncClient.java	Documents async trait headers.
azure/core/traits/implementation/TraitsClientImpl.java	Regenerates trait implementation docs.
ClientMethodTemplateBase.java	Generates reusable Javadoc tables and response-header rows.
ProxyMethodResponseHeader.java	Adds the response-header metadata model.
ProxyMethod.java	Stores and preserves response-header metadata.
ProxyMethodMapper.java	Maps successful response headers into proxy metadata.
.chronus/changes/http-client-java-response-header-javadocs-2026-08-10.md	Records the Java generator fix.

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.