[Automated][tcgc] Document SSE metadata, versionsEnum, and boolean string encoding in TCGC emitter docs - #2
Draft
github-actions[bot] wants to merge 1 commit into
Conversation
…ncoding Co-authored-by: Copilot <223556219+Copilot@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.
Summary
Incremental documentation update for
@azure-tools/typespec-client-generator-core(TCGC) based on recent source changes to the client type graph. Updates the emitter developer guideline and the doc-updater knowledge base.Changes
Emitter developer docs (
guideline.md):sseMetadataproperty (SdkSseMetadata/SdkSseEventMetadata) that now appears alongsidestreamMetadataonSdkBodyParameter,SdkMethodResponse, and the HTTP response, including allSdkSseEventMetadatafields (eventType,isTerminalEvent,isEventEnvelope,type/contentType,payloadType/payloadContentType).SdkClientType.versionsEnum— documented the new property in the Client section (points to the service's versions enum;undefinedfor unversioned services and multi-service root clients).@encode(string)— noted that boolean, in addition to integer types, now supports string encoding (encode: "string") in the Built-in Typesencodedescription.Knowledge base (
eng/scripts/doc-updater/knowledge/tcgc.md):versionsEnum, boolean string encoding, and the linter-rulefileRefdocs (the three active rules are already reflected inreference/linter.md; the removedno-unnamed-typesrule is net-unregistered).**Meta(redacted) updated
tcgc.meta.jsonto the processed checkout commit.Notes
test/methods/sse.test.ts,test/types/built-in.test.ts,test/package/versioning.test.ts).<ClientTabs>examples are required.regen-docs(requires a full package + core-submodule build) and are not hand-edited here.