Repository navigation
[docs-sync] Update documentation for recent code changes - #14
Draft
github-actions[bot] wants to merge 1 commit into
Draft
github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
Reflect the new decorator-requires-scope validation added in Azure#5119. Both @convenientAPI and @protocolAPI must now be scoped to "java" and/or "csharp" — using them without a proper scope generates a decorator-requires-scope warning. Updated documentation notes and examples accordingly. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This branch has not been deployed
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
Updates TCGC decorator documentation to reflect the new
decorator-requires-scopevalidation introduced in commit6aa2554(PR Azure#5119).Changes
website/src/content/docs/docs/libraries/typespec-client-generator-core/reference/decorators.md@convenientAPI: Added a note that this decorator must be scoped to"java"and/or"csharp"(the only emitters that consume it). Updated all three examples to include an explicit scope. Changed thescopeparameter description to reflect the valid values.@protocolAPI: Same treatment as@convenientAPI— added the scope-requirement note and updated examples.Why
PR Azure#5119 added a new
decorator-requires-scopevalidation that warns when@convenientAPIor@protocolAPIis used without a"java"or"csharp"scope. The existing docs showed examples without any scope (e.g.,@convenientAPI(false)) and described the scope parameter as optional with a default of "all emitters". Those examples and descriptions were now misleading and would generate warnings in practice.