[docs-sync] Update documentation for recent code changes - #11
Draft
github-actions[bot] wants to merge 1 commit into
Draft
[docs-sync] Update documentation for recent code changes#11github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
The @azure-tools/typespec-ts emitter now automatically renames operations that use JavaScript reserved words (e.g. 'delete') when they belong to an operation group, by suffixing the singularized group name. Document this behavior in the 'Generate client libraries' renaming how-to guide, including the @clientName escape hatch for preserving the original name in already-shipped SDKs. Relates to: Azure#5154 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 documentation to reflect code changes merged in the past 7 days.
Changes made
website/src/content/docs/docs/howtos/Generate client libraries/09renaming.mdxAdded a new subsection "JavaScript reserved-word operations" documenting the behavior introduced in Azure/typespec-azure#5154:
@azure-tools/typespec-tsemitter now automatically renames operations with JavaScript reserved-word names (e.g.delete,in) that belong to an operation group, by appending the singularized group name (e.g.Conversations.delete→deleteConversation).@clientName("delete", "javascript")escape hatch for preserving the original name in already-shipped SDKs.Reviewed but already up-to-date
no-openapi-client-extensionslinter rule (Add no-openapi-client-extensions linter rule Azure/typespec-azure#5109): Already added towebsite/src/content/docs/docs/libraries/azure-core/reference/linter.mdand the rule detail page is generated from source.arm-resource-operationlint rule (Splitarm-resource-operationlint rule into three focused rules Azure/typespec-azure#4808): The three new rules (use-interface,use-api-version,use-operation-decorator) are already listed inwebsite/src/content/docs/docs/libraries/azure-resource-manager/reference/linter.mdwith a URL redirect inastro.config.mjs.