Skip to content

[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
mainfrom
doc-update/tcgc-sse-versions-encode-06fcce9b3896d6a8
Draft

[Automated][tcgc] Document SSE metadata, versionsEnum, and boolean string encoding in TCGC emitter docs#2
github-actions[bot] wants to merge 1 commit into
mainfrom
doc-update/tcgc-sse-versions-encode-06fcce9b3896d6a8

Conversation

@github-actions

Copy link
Copy Markdown

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):

  • Server-Sent Events / streaming — added a "Streaming and Server-Sent Events" subsection under Operation documenting the new sseMetadata property (SdkSseMetadata / SdkSseEventMetadata) that now appears alongside streamMetadata on SdkBodyParameter, SdkMethodResponse, and the HTTP response, including all SdkSseEventMetadata fields (eventType, isTerminalEvent, isEventEnvelope, type/contentType, payloadType/payloadContentType).
  • SdkClientType.versionsEnum — documented the new property in the Client section (points to the service's versions enum; undefined for unversioned services and multi-service root clients).
  • Boolean @encode(string) — noted that boolean, in addition to integer types, now supports string encoding (encode: "string") in the Built-in Types encode description.

Knowledge base (eng/scripts/doc-updater/knowledge/tcgc.md):

  • Recorded lessons for the SSE metadata surface, versionsEnum, boolean string encoding, and the linter-rule fileRef docs (the three active rules are already reflected in reference/linter.md; the removed no-unnamed-types rule is net-unregistered).

**Meta(redacted) updated tcgc.meta.json to the processed checkout commit.

Notes

  • All changes verified against the corresponding unit tests (test/methods/sse.test.ts, test/types/built-in.test.ts, test/package/versioning.test.ts).
  • The new type-graph surface is emitter-consumed metadata covered by unit tests; no Spector specs or <ClientTabs> examples are required.
  • Per-rule reference pages and js-api reference pages are auto-generated via regen-docs (requires a full package + core-submodule build) and are not hand-edited here.

Generated by Documentation Update Agent · 238.7 AIC · ⌖ 21.1 AIC · ⊞ 8.1K ·

…ncoding

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants