-
Notifications
You must be signed in to change notification settings - Fork 5.4k
NVAInVnet swagger changes #35093
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
NVAInVnet swagger changes #35093
Conversation
Next Steps to MergeNext steps that must be taken to merge this PR:
|
PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment. |
Commenter does not have sufficient privileges for PR 35093 in repo Azure/azure-rest-api-specs |
"type": "object", | ||
"properties": { | ||
"subnet": { | ||
"readOnly": false, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the feedback. We understand the concern regarding the use of ARM top-level property names. However, in this case, the "type" property is already established in a related configuration(screenshot above) and is used to indicate the NIC type (PublicNic or PrivateNic). The new property being introduced is closely tied to the existing one, and both are interdependent.
To maintain consistency and parity across the API model, we would prefer to retain the name type for this property. This aligns with the current structure and avoids introducing divergence in naming conventions within the same context.
Please let us know if you have any further concerns or suggestions.
"value": "AdditionalPublicNic", | ||
"description": "An additional public NIC type" | ||
} | ||
] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the feedback. We understand the guidance around avoiding ARM top-level property names. However, the name property is already used in the existing API for related configurations, and the new property being introduced is closely aligned with that structure (screenshot above).
To maintain consistency and parity across the API surface, especially for features that are interdependent, we would prefer to retain the use of name in this context.
Please let us know if you have any concerns with this approach.
}, | ||
"description": "Specifies input parameters required NVA in VNet interface configuration." | ||
}, | ||
"NvaInVnetSubnetReferenceProperties": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the feedback @mentat9 . Referenced resources in our model are currently represented using the ResourceType.Id pattern. For example:
- "virtualHub": { "id": "/subscriptions/.../virtualHubs/RahulTestHub" }
- "internetIngressPublicIps": [{ "id": "/subscriptions/.../publicIPAddresses/slbip1" }]
To maintain alignment with this established convention—especially within Hybrid Networking—we’ve applied the same approach for the new subnet reference field. Given that the current naming is consistent with existing patterns and already integrated into the codebase, we’d prefer to retain it as is.
/azp run |
Commenter does not have sufficient privileges for PR 35093 in repo Azure/azure-rest-api-specs |
PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts. |
Closing as new base branch was created by Prajwal. Will reopen PR with new base branch |
Choose a PR Template
Switch to "Preview" on this description then select one of the choices below.
Click here to open a PR for a Data Plane API.
Click here to open a PR for a Control Plane (ARM) API.
Click here to open a PR for only SDK configuration.