[docs-sync] Update documentation for recent code changes - #4
Draft
github-actions[bot] wants to merge 1 commit into
Draft
[docs-sync] Update documentation for recent code changes#4github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
- Add documentation for SdkClientType.versionsEnum, a new optional property that references the API versions enum for a client's service (added in Azure#4977) - Document streamMetadata and sseMetadata on body parameters, describing SdkStreamMetadata and SdkSseMetadata / SdkSseEventMetadata structures added for SSE event-stream support (added in Azure#4882) - Document streamMetadata and sseMetadata on HTTP responses 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 updates the TCGC emitter guideline to document two recent additions to the TCGC public API.
Changes
website/src/content/docs/docs/libraries/typespec-client-generator-core/guideline.mdSdkClientType.versionsEnum(introduced in #4977 / commit84fe6d61):Added a paragraph in the Client section explaining the new optional
versionsEnumproperty onSdkClientType. This property references theSdkEnumTyperepresenting the API versions enum for the client's service, allowing emitters to map a client to its versions enum — particularly useful for mixed API-version scenarios.streamMetadata/sseMetadataon body parameters and responses (introduced in #4882 / commit383366f5):Added documentation in the HTTP Operation Parameters Handling and HTTP Operation Response Calculation sections for the new
sseMetadatafield (typeSdkSseMetadata) added toSdkBodyParameter,SdkMethodResponse, andSdkHttpResponse. Also documented the newly addedSdkSseMetadataandSdkSseEventMetadatainterfaces, which give emitters the per-event information needed to deserialize SSE streams without re-deriving it from raw TypeSpec.Not included
a665f432,43e80a69) — no user-facing doc impact.packages/*/src/rules/*.md(46683e57) — these are source files for generated website pages; the website pages themselves are regenerated bytspd docand are.gitignored.beb23044(collection typeserializationOptions) — already updatedguideline.mdin the same commit.91d21e94(no-unnamed-types) — already updated the linter reference pages in the same commit.