[docs-sync] Update documentation for recent code changes - #5
Draft
github-actions[bot] wants to merge 1 commit into
Draft
[docs-sync] Update documentation for recent code changes#5github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
- Document versionsEnum field on SdkClientType (added in Azure#4977) - Document SdkSseMetadata and SdkSseEventMetadata for SSE streams (added in Azure#4882) 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
This PR syncs the TCGC emitter guideline documentation with recent code changes from the past 7 days.
Changes
website/src/content/docs/docs/libraries/typespec-client-generator-core/guideline.mdversionsEnumonSdkClientType(from #4977 / commit84fe6d61):Added a paragraph documenting the new
versionsEnum?: SdkEnumTypefield. Emitters can use it to map a client to its corresponding API versions enum, which is needed for mixed API-version scenarios where different clients may have different version enums.SSE event metadata (from #4882 / commit
383366f5):Added an "Server-Sent Events (SSE)" subsection under the Method section documenting the new
SdkSseMetadataandSdkSseEventMetadatainterfaces. These expose per-event metadata (event type, terminal flag, envelope/payload types, content types) on method responses, HTTP responses, and body parameters fortext/event-streamoperations.