docs(http-client-java): document how to inspect TCGC SDK output for a spec - #11421
Merged
weidongxu-microsoft merged 2 commits intoJul 28, 2026
Conversation
… spec Add a generic step to the code-generator instructions describing how to dump the TCGC SDK model (tcgc-output.yaml) by running @azure-tools/typespec-client-generator-core as the emitter, to inspect the SDK view upstream of code-model.yaml without adding emitter debug logging. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: c5e83986-de71-4e8d-bfaa-abb4b62cb3a3
Contributor
|
No changes needing a change description found. |
|
You can try these changes here
|
Relocate the TCGC SDK-model inspection guidance into a concise subsection of the 'Edit -> update emitter -> test loop' section, since it is a helper for that loop, and tighten the wording. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: c5e83986-de71-4e8d-bfaa-abb4b62cb3a3
weidongxu-microsoft
marked this pull request as ready for review
July 28, 2026 05:30
weidongxu-microsoft
requested review from
XiaofeiCao,
alzimmermsft,
haolingdong-msft and
jsquire
as code owners
July 28, 2026 05:30
XiaofeiCao
approved these changes
Jul 28, 2026
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
2 participants
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.
Adds a generic step to the http-client-java code-generator instructions describing how to inspect the TCGC SDK model for a spec.
The emitter is built on top of TCGC (
@azure-tools/typespec-client-generator-core). When investigating how a type is named, whether a response has a body vs. only headers, how operations are nested under clients, etc., it is often more reliable to inspect what TCGC hands to the emitter than to add debug logging in the emitter.The documented flow runs TCGC as the emitter to dump
tcgc-output.yaml(the serializedSdkPackage):This is the SDK view upstream of
code-model.yaml, requires no emitter/generator changes, and should not be committed (verification-only).Docs-only change.