[AutoPR @azure-arm-netapp]-generated-from-SDK Generation - JS-6620661 - #39410
[AutoPR @azure-arm-netapp]-generated-from-SDK Generation - JS-6620661#39410azure-sdk-automation[bot] wants to merge 1 commit into
Conversation
…pp/NetApp/tspconfig.yaml', SDK Release Type: beta, and CommitSHA: 'c97fe996d4a10f7d583b7951b07bd4b52b3a1be0' in SpecRepo: 'https://github.com/Azure/azure-rest-api-specs' Pipeline run: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=6620661 Refer to https://eng.ms/docs/products/azure-developer-experience/develop/sdk-release/sdk-release-prerequisites to prepare for SDK release.
|
Azure Pipelines: Successfully started running 1 pipeline(s). 9 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run. |
Next Steps to MergeOnly failed checks and required actions are listed below.
Need a hand? Feel free to ask in the [Language – JS & TS 🥷 Teams channel]((teams.microsoft.com/redacted) — we're happy to help. |
There was a problem hiding this comment.
1 design issue found in the API surface for @azure/arm-netapp v25.0.0-beta.2.
The new Elastic* interfaces introduced in this PR (9 new operation groups) use eTag (camelCase) for the ETag property, while every existing interface in the SDK — including the also-new ActiveDirectoryConfig — uses etag (all lowercase). This naming inconsistency is a public API surface issue that should be corrected at the TypeSpec/generation-tooling level before GA.
No CHANGELOG baseline issues, no tool issues, and no API-version regression were found.
📊 Structured Report
{"agent":"mgmt-reviewer","pr":39410,"summary":"issues_found","findings":[{"file":"sdk/netapp/arm-netapp/review/arm-netapp-node.api.md","line":1012,"issueType":"design","category":"naming-inconsistency","description":"New Elastic* interfaces use eTag (camelCase) while all existing SDK interfaces use etag (lowercase). Affected: ElasticAccount, ElasticBackupPolicy, ElasticBackupVault, ElasticCapacityPool, ElasticSnapshotPolicy, ElasticSnapshot (lines 913, 1012, 1097, 1145, 1349, 1443)."}]}Warning
Firewall blocked 1 domain
The following domain was blocked by the firewall during workflow execution:
awmgmcpg
To allow these domains, add them to the
network.allowedlist in your workflow frontmatter:
network:
allowed:
- defaults
- "awmgmcpg"See Network Configuration for more information.
⚡ Benchmarked by Management Release Assistant
|
|
||
| // @public | ||
| export interface ElasticBackupPolicy extends TrackedResource { | ||
| readonly eTag?: string; |
There was a problem hiding this comment.
🔴 Design Issue — eTag property naming inconsistency
The newly added ElasticBackupPolicy interface (and other new Elastic* interfaces such as ElasticAccount, ElasticBackupVault, ElasticCapacityPool, ElasticSnapshotPolicy, ElasticSnapshot) expose readonly eTag?: string (camelCase), while all existing interfaces in this SDK use readonly etag?: string (all lowercase).
Examples of the inconsistency:
- Existing (lowercase):
ActiveDirectoryConfig.etag,NetAppAccount.etag,CapacityPool.etag - New (camelCase):
ElasticBackupPolicy.eTag,ElasticSnapshotPolicy.eTag,ElasticAccount.eTag
This produces an inconsistent public API where consumers must remember different casing for the same conceptual field depending on which resource type they use.
Fix: Align the Elastic* interfaces to use etag (all lowercase) to match the rest of the SDK, and report this discrepancy to the spec/generation tooling team so it can be corrected at the source.
Configurations: 'specification/netapp/resource-manager/Microsoft.NetApp/NetApp/tspconfig.yaml', SDK Release Type: beta, and CommitSHA: 'c97fe996d4a10f7d583b7951b07bd4b52b3a1be0' in SpecRepo: 'https://github.com/Azure/azure-rest-api-specs' Pipeline run: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=6620661 Refer to https://eng.ms/docs/products/azure-developer-experience/develop/sdk-release/sdk-release-prerequisites to prepare for SDK release. Release plan link: https://azsdk-releaseplan-dashboard-hveph5aqhhcfhtgu.westus-01.azurewebsites.net/?releaseplan=35587 Submitted by: b-sunilhn@microsoft.com