From 643de5b891422e1c75da639e8ce8d6bd5e492904 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 27 Jul 2026 18:22:29 +0000 Subject: [PATCH 1/2] Initial plan From 754d74a4847ca5c4e94b4598f5d234b570abac24 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 27 Jul 2026 18:31:06 +0000 Subject: [PATCH 2/2] Fix ARM library doc-comment typos and regenerate reference docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - operations.tsp: "and endpoint" → "an endpoint" - responses.tsp: "fo" → "of", "being updated" → "being created" - decorators.tsp: "autoRout" → "autoRoute" - common-types/nsp-operations.tsp: removed ghost @template tags, "parameter" → "perimeter" - common-types/private-links-ref.tsp: "private endpoint" → "private link" - common-types/managed-identity-ref.tsp: "service-assigned" → "system-assigned" - legacy-types/operations.tsp: "form" → "from", "being patched" → "being listed" - legacy-types/private-endpoints.tsp: removed ghost @template tags - legacy-types/extension.tsp: "created or updated" → "updated" for PATCH ops Closes #5061 Co-authored-by: markcowl <1054056+markcowl@users.noreply.github.com> --- ...fix-arm-doc-comments-2026-07-27-18-23-00.md | 7 +++++++ .../typespec-azure-resource-manager/README.md | 2 +- .../generated-defs/Azure.ResourceManager.ts | 2 +- .../lib/common-types/managed-identity-ref.tsp | 2 +- .../lib/common-types/nsp-operations.tsp | 6 +----- .../lib/common-types/private-links-ref.tsp | 2 +- .../lib/decorators.tsp | 2 +- .../lib/legacy-types/extension.tsp | 4 ++-- .../lib/legacy-types/operations.tsp | 8 ++++---- .../lib/legacy-types/private-endpoints.tsp | 2 -- .../lib/operations.tsp | 4 ++-- .../lib/responses.tsp | 6 +++--- .../reference/data-types.md | 6 +++--- .../reference/decorators.md | 2 +- .../reference/interfaces.md | 18 +++++++++--------- 15 files changed, 37 insertions(+), 36 deletions(-) create mode 100644 .chronus/changes/fix-arm-doc-comments-2026-07-27-18-23-00.md diff --git a/.chronus/changes/fix-arm-doc-comments-2026-07-27-18-23-00.md b/.chronus/changes/fix-arm-doc-comments-2026-07-27-18-23-00.md new file mode 100644 index 0000000000..7548623917 --- /dev/null +++ b/.chronus/changes/fix-arm-doc-comments-2026-07-27-18-23-00.md @@ -0,0 +1,7 @@ +--- +changeKind: internal +packages: + - "@azure-tools/typespec-azure-resource-manager" +--- + +Fix doc-comment typos in ARM library `.tsp` files and regenerate reference docs. diff --git a/packages/typespec-azure-resource-manager/README.md b/packages/typespec-azure-resource-manager/README.md index a33fd393de..5d3360680b 100644 --- a/packages/typespec-azure-resource-manager/README.md +++ b/packages/typespec-azure-resource-manager/README.md @@ -328,7 +328,7 @@ of the operations will be grouped based on the interface name in generated clients. The optional `resourceOperationOptions` parameter provides additional options. -`allowStaticRoutes` turns off autoRout for the interface, so individual operations can +`allowStaticRoutes` turns off autoRoute for the interface, so individual operations can choose static (`@route`) or automatic (`@autoRoute`) routing. `resourceType: Model` specifies the resource type for the operations in the interface diff --git a/packages/typespec-azure-resource-manager/generated-defs/Azure.ResourceManager.ts b/packages/typespec-azure-resource-manager/generated-defs/Azure.ResourceManager.ts index ba30df633e..6ab882108b 100644 --- a/packages/typespec-azure-resource-manager/generated-defs/Azure.ResourceManager.ts +++ b/packages/typespec-azure-resource-manager/generated-defs/Azure.ResourceManager.ts @@ -314,7 +314,7 @@ export type ArmResourceCheckExistenceDecorator = ( * clients. * * The optional `resourceOperationOptions` parameter provides additional options. - * `allowStaticRoutes` turns off autoRout for the interface, so individual operations can + * `allowStaticRoutes` turns off autoRoute for the interface, so individual operations can * choose static (`@route`) or automatic (`@autoRoute`) routing. * * `resourceType: Model` specifies the resource type for the operations in the interface diff --git a/packages/typespec-azure-resource-manager/lib/common-types/managed-identity-ref.tsp b/packages/typespec-azure-resource-manager/lib/common-types/managed-identity-ref.tsp index 54de0d5368..6f5c39d41f 100644 --- a/packages/typespec-azure-resource-manager/lib/common-types/managed-identity-ref.tsp +++ b/packages/typespec-azure-resource-manager/lib/common-types/managed-identity-ref.tsp @@ -53,7 +53,7 @@ namespace Azure.ResourceManager.CommonTypes; ); /** - * The properties of the service-assigned identity associated with this resource. + * The properties of the system-assigned identity associated with this resource. */ @@armCommonDefinition( SystemAssignedServiceIdentity, diff --git a/packages/typespec-azure-resource-manager/lib/common-types/nsp-operations.tsp b/packages/typespec-azure-resource-manager/lib/common-types/nsp-operations.tsp index 69543d427f..c3ebfb9308 100644 --- a/packages/typespec-azure-resource-manager/lib/common-types/nsp-operations.tsp +++ b/packages/typespec-azure-resource-manager/lib/common-types/nsp-operations.tsp @@ -96,8 +96,6 @@ interface NspConfigurationOperations< * @template ParentResource the parent resource of the NspConfiguration * @template Resource Optional. The NspConfiguration resource being listed * @template BaseParameters Optional. Allows overriding the operation parameters - * @template ParentName Optional. The name of the parent resource - * @template ParentFriendlyName Optional. The friendly name of the parent resource * @template Parameters Optional. Additional parameters after the path parameters * @template Response Optional. The success response for the list operation * @template Error Optional. The error response, if non-standard. @@ -127,12 +125,10 @@ interface NspConfigurationOperations< >; /** - * List the network security parameter configuration for a resource without pagination - this should only be used for legacy operations + * List the network security perimeter configuration for a resource without pagination - this should only be used for legacy operations * @template ParentResource the parent resource of the NspConfiguration * @template Resource Optional. The NspConfiguration resource being listed * @template BaseParameters Optional. Allows overriding the operation parameters - * @template ParentName Optional. The name of the parent resource - * @template ParentFriendlyName Optional. The friendly name of the parent resource * @template Parameters Optional. Additional parameters after the path parameters * @template Response Optional. The success response for the list operation * @template Error Optional. The error response, if non-standard. diff --git a/packages/typespec-azure-resource-manager/lib/common-types/private-links-ref.tsp b/packages/typespec-azure-resource-manager/lib/common-types/private-links-ref.tsp index e1579d7287..9259b88fe4 100644 --- a/packages/typespec-azure-resource-manager/lib/common-types/private-links-ref.tsp +++ b/packages/typespec-azure-resource-manager/lib/common-types/private-links-ref.tsp @@ -30,7 +30,7 @@ namespace Azure.ResourceManager.CommonTypes; "privatelinks.json" ); -/** The private endpoint resource */ +/** The private link resource */ @@armCommonDefinition( PrivateLinkResource, "PrivateLinkResource", diff --git a/packages/typespec-azure-resource-manager/lib/decorators.tsp b/packages/typespec-azure-resource-manager/lib/decorators.tsp index 322f08319b..66ec31b001 100644 --- a/packages/typespec-azure-resource-manager/lib/decorators.tsp +++ b/packages/typespec-azure-resource-manager/lib/decorators.tsp @@ -223,7 +223,7 @@ extern dec armResourceCheckExistence( * clients. * * The optional `resourceOperationOptions` parameter provides additional options. - * `allowStaticRoutes` turns off autoRout for the interface, so individual operations can + * `allowStaticRoutes` turns off autoRoute for the interface, so individual operations can * choose static (`@route`) or automatic (`@autoRoute`) routing. * * `resourceType: Model` specifies the resource type for the operations in the interface diff --git a/packages/typespec-azure-resource-manager/lib/legacy-types/extension.tsp b/packages/typespec-azure-resource-manager/lib/legacy-types/extension.tsp index 6cc60e2931..2f4ee1f2ec 100644 --- a/packages/typespec-azure-resource-manager/lib/legacy-types/extension.tsp +++ b/packages/typespec-azure-resource-manager/lib/legacy-types/extension.tsp @@ -94,7 +94,7 @@ interface ExtensionOperations< /** * A long-running resource Update (PATCH) - * @template Resource the resource being created or updated + * @template Resource the resource being updated * @template PatchModel the PATCH request model * @template LroHeaders Optional. Allows overriding the lro headers returned on resource create * @template Parameters Optional. Additional parameters after the path parameters @@ -134,7 +134,7 @@ interface ExtensionOperations< /** * A synchronous resource Update (PATCH) - * @template Resource the resource being created or updated + * @template Resource the resource being updated * @template PatchModel the PATCH request model * @template Parameters Optional. Additional parameters after the path parameters * @template Response Optional. The success response(s) for the PATCH operation diff --git a/packages/typespec-azure-resource-manager/lib/legacy-types/operations.tsp b/packages/typespec-azure-resource-manager/lib/legacy-types/operations.tsp index f5c6161ad0..7083312009 100644 --- a/packages/typespec-azure-resource-manager/lib/legacy-types/operations.tsp +++ b/packages/typespec-azure-resource-manager/lib/legacy-types/operations.tsp @@ -13,7 +13,7 @@ using Rest; * is accessible at multiple, fixed resource paths. * @template ParentParameters The path parameters for the resource parent * @template ResourceTypeParameter The path parameter for the resource name - * @template ErrorType Optional. The type of error models used in operations created form this template + * @template ErrorType Optional. The type of error models used in operations created from this template * @template ResourceName Optional. The name of the resource type described in this template */ interface LegacyOperations< @@ -34,7 +34,7 @@ interface LegacyOperations< * is accessible at multiple, fixed resource paths. Can be used with static routes. * @template ParentParameters The path parameters for the resource parent * @template ResourceTypeParameter The path parameter for the resource name - * @template ErrorType Optional. The type of error models used in operations created form this template + * @template ErrorType Optional. The type of error models used in operations created from this template * @template ResourceRoute Optional. The resource route to use for operations in the interface. * @template RoutedResourceName Optional. The name of the resource type described in this template */ @@ -660,7 +660,7 @@ op CreateOrReplaceSync< /** * A resource list operation, at the subscription scope, that lists only a single page - * @template Resource the resource being patched + * @template Resource the resource being listed * @template Parameters Optional. Additional parameters after the path parameters * @template Response Optional. The success response for the list operation * @template Error Optional. The error response, if non-standard. @@ -681,7 +681,7 @@ op ArmListSinglePageBySubscription< /** * A resource list operation, at the scope of the resource's parent that lists only a single page. - * @template Resource the resource being patched + * @template Resource the resource being listed * @template BaseParameters Optional. Allows overriding the operation parameters * @template ParentName Optional. The name of the parent resource * @template ParentFriendlyName Optional. The friendly name of the parent resource diff --git a/packages/typespec-azure-resource-manager/lib/legacy-types/private-endpoints.tsp b/packages/typespec-azure-resource-manager/lib/legacy-types/private-endpoints.tsp index b4fcdb40b1..bfb3a9a975 100644 --- a/packages/typespec-azure-resource-manager/lib/legacy-types/private-endpoints.tsp +++ b/packages/typespec-azure-resource-manager/lib/legacy-types/private-endpoints.tsp @@ -12,8 +12,6 @@ using Rest; * @template ParentResource the parent resource of the PrivateEndpointConnection * @template Resource Optional. The PrivateEndpointConnection resource being listed * @template BaseParameters Optional. Allows overriding the operation parameters - * @template ParentName Optional. The name of the parent resource - * @template ParentFriendlyName Optional. The friendly name of the parent resource * @template Parameters Optional. Additional parameters after the path parameters * @template Response Optional. The success response for the list operation * @template Error Optional. The error response, if non-standard. diff --git a/packages/typespec-azure-resource-manager/lib/operations.tsp b/packages/typespec-azure-resource-manager/lib/operations.tsp index 9cc3af6097..115daca609 100644 --- a/packages/typespec-azure-resource-manager/lib/operations.tsp +++ b/packages/typespec-azure-resource-manager/lib/operations.tsp @@ -885,7 +885,7 @@ op ArmResourceActionNoContentSync< /** * Adds check global name availability operation, normally used if * a resource name must be globally unique (for example, if the resource - * exposes and endpoint that uses the resource name in the url) + * exposes an endpoint that uses the resource name in the url) * @template Request the availability request, defaults to the standard request, containing name and resource type * @template Response the availability response, default to the standard response * @template AdditionalParams A model specifying additional non-path parameters to the availability request @@ -905,7 +905,7 @@ op checkGlobalNameAvailability< /** * Adds check location-specific name availability operation, normally used if * a resource name must be globally unique (for example, if the resource - * exposes and endpoint that uses the resource name in the url) + * exposes an endpoint that uses the resource name in the url) * @template Request the availability request, defaults to the standard request, containing name and resource type * @template Response the availability response, default to the standard response * @template AdditionalParams A model specifying additional non-path parameters to the availability request diff --git a/packages/typespec-azure-resource-manager/lib/responses.tsp b/packages/typespec-azure-resource-manager/lib/responses.tsp index 990a01530a..c13dc9a870 100644 --- a/packages/typespec-azure-resource-manager/lib/responses.tsp +++ b/packages/typespec-azure-resource-manager/lib/responses.tsp @@ -246,7 +246,7 @@ model ArmLroLocationHeader< * @template StatusMonitor The type of the polling StatusMonitor when following the Azure-AsyncOperation url * @template FinalResult The type of the logical result when following the location header * @template PollingUrlValue The value type of the link to the status monitor - * @template FinalUrlValue The value type fo the link to the final result + * @template FinalUrlValue The value type of the link to the final result * * @example * ```typespec @@ -320,7 +320,7 @@ model ArmResourceUpdatedResponse | Name | Description | | ---------- | ---------------------------------------------------------- | -| Resource | The resource being updated | +| Resource | The resource being created | | LroHeaders | Optional. The lro headers returned with a Created response | #### Examples @@ -463,7 +463,7 @@ model Azure.ResourceManager.ArmResourceCreatedSyncResponse | Name | Description | | -------- | -------------------------- | -| Resource | The resource being updated | +| Resource | The resource being created | #### Examples diff --git a/website/src/content/docs/docs/libraries/azure-resource-manager/reference/decorators.md b/website/src/content/docs/docs/libraries/azure-resource-manager/reference/decorators.md index 715df3bede..97d8719b9f 100644 --- a/website/src/content/docs/docs/libraries/azure-resource-manager/reference/decorators.md +++ b/website/src/content/docs/docs/libraries/azure-resource-manager/reference/decorators.md @@ -235,7 +235,7 @@ of the operations will be grouped based on the interface name in generated clients. The optional `resourceOperationOptions` parameter provides additional options. -`allowStaticRoutes` turns off autoRout for the interface, so individual operations can +`allowStaticRoutes` turns off autoRoute for the interface, so individual operations can choose static (`@route`) or automatic (`@autoRoute`) routing. `resourceType: Model` specifies the resource type for the operations in the interface diff --git a/website/src/content/docs/docs/libraries/azure-resource-manager/reference/interfaces.md b/website/src/content/docs/docs/libraries/azure-resource-manager/reference/interfaces.md index fb4cfa58e3..96392c31de 100644 --- a/website/src/content/docs/docs/libraries/azure-resource-manager/reference/interfaces.md +++ b/website/src/content/docs/docs/libraries/azure-resource-manager/reference/interfaces.md @@ -1621,7 +1621,7 @@ op Azure.ResourceManager.ArmTagsPatchSync(properties: Azure.ResourceManager.Foun Adds check global name availability operation, normally used if a resource name must be globally unique (for example, if the resource -exposes and endpoint that uses the resource name in the url) +exposes an endpoint that uses the resource name in the url) ```typespec op Azure.ResourceManager.checkGlobalNameAvailability(apiVersion: string, subscriptionId: Azure.Core.uuid, provider: "Microsoft.ThisWillBeReplaced", body: Request): Response | Azure.ResourceManager.CommonTypes.ErrorResponse @@ -1639,7 +1639,7 @@ op Azure.ResourceManager.checkGlobalNameAvailability(apiVersion: string, subscri Adds check location-specific name availability operation, normally used if a resource name must be globally unique (for example, if the resource -exposes and endpoint that uses the resource name in the url) +exposes an endpoint that uses the resource name in the url) ```typespec op Azure.ResourceManager.checkLocalNameAvailability(apiVersion: string, subscriptionId: Azure.Core.uuid, provider: "Microsoft.ThisWillBeReplaced", location: Azure.Core.azureLocation, body: Request): Response | Azure.ResourceManager.CommonTypes.ErrorResponse @@ -1717,7 +1717,7 @@ op Azure.ResourceManager.CommonTypes.NspConfigurationOperations.ListSinglePageByParent} -List the network security parameter configuration for a resource without pagination - this should only be used for legacy operations +List the network security perimeter configuration for a resource without pagination - this should only be used for legacy operations ```typespec op Azure.ResourceManager.CommonTypes.NspConfigurationOperations.ListSinglePageByParent(provider: "Microsoft.ThisWillBeReplaced"): Response | Error @@ -2307,7 +2307,7 @@ op Azure.ResourceManager.Legacy.ExtensionOperations.CreateOrUpdateAsync} @@ -2652,7 +2652,7 @@ interface Azure.ResourceManager.Legacy.RoutedOperations