-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
Add network interface configuration schema for virtual machine network profile #13449
Conversation
Hi, @basharg Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com |
Swagger Validation Report
|
Rule | Message |
---|---|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: primary Location: Microsoft.Compute/stable/2021-03-01/compute.json#L9625 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: primary Location: Microsoft.Compute/stable/2021-03-01/compute.json#L9699 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableAcceleratedNetworking Location: Microsoft.Compute/stable/2021-03-01/compute.json#L9715 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableFpga Location: Microsoft.Compute/stable/2021-03-01/compute.json#L9719 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableIPForwarding Location: Microsoft.Compute/stable/2021-03-01/compute.json#L9723 |
|
'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Compute/stable/2021-03-01/compute.json#L9606 |
|
'sku' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Compute/stable/2021-03-01/compute.json#L9610 |
|
'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Compute/stable/2021-03-01/compute.json#L9675 |
|
'dscpConfiguration' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Compute/stable/2021-03-01/compute.json#L9742 |
|
'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Compute/stable/2021-03-01/compute.json#L9757 |
The following errors/warnings exist before current PR submission:
Only 10 items are listed, please refer to log for more details.
Rule | Message |
---|---|
D5001 - XmsExamplesRequired |
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Location: Microsoft.Compute/stable/2021-03-01/compute.json#L36 |
D5001 - XmsExamplesRequired |
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Disks_Delete' Location: Microsoft.Compute/stable/2020-12-01/disk.json#L223 |
D5001 - XmsExamplesRequired |
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Disks_GrantAccess' Location: Microsoft.Compute/stable/2020-12-01/disk.json#L327 |
D5001 - XmsExamplesRequired |
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Disks_RevokeAccess' Location: Microsoft.Compute/stable/2020-12-01/disk.json#L374 |
D5001 - XmsExamplesRequired |
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Snapshots_Update' Location: Microsoft.Compute/stable/2020-12-01/disk.json#L465 |
D5001 - XmsExamplesRequired |
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Snapshots_Delete' Location: Microsoft.Compute/stable/2020-12-01/disk.json#L544 |
D5001 - XmsExamplesRequired |
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Snapshots_GrantAccess' Location: Microsoft.Compute/stable/2020-12-01/disk.json#L648 |
D5001 - XmsExamplesRequired |
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Snapshots_RevokeAccess' Location: Microsoft.Compute/stable/2020-12-01/disk.json#L695 |
R2020 - RequiredPropertiesMissingInResourceModel |
Model definition 'SubResourceWithColocationStatus' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly. Location: Microsoft.Compute/stable/2021-03-01/compute.json#L7131 |
R2026 - AvoidAnonymousTypes |
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Microsoft.Compute/stable/2021-03-01/compute.json#L9965 |
️⚠️
Avocado: 1 Warnings warning [Detail]
Rule | Message |
---|---|
The default tag contains multiple API versions swaggers. readme: specification/compute/resource-manager/readme.md tag: specification/compute/resource-manager/readme.md#tag-package-2021-03-01 |
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌
Cross Version BreakingChange (Base on preview version): 11 Errors, 4 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.8.9)
- original: preview/2016-04-30-preview/compute.json <---> new: stable/2021-03-01/compute.json
Only 10 items are listed, please refer to log for more details.
️️✔️
Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
- Compared Swaggers (Based on Oad v0.8.9)
- original: stable/2020-12-01/compute.json <---> new: stable/2021-03-01/compute.json
️❌
[Staging] SDK Track2 Validation: 1 Errors, 0 Warnings failed [Detail]
- The following tags are being changed in this PR
Rule | Message |
---|---|
PreCheck/DuplicateSchema |
"readme":"compute/resource-manager/readme.md", "tag":"package-2021-03-01", "details":"Duplicate Schema named PurchasePlan -- properties.promotionCode: undefined => "description":"The Offer Promotion Code.", "$ref":"#/components/schemas/schemas:1286" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
AutorestCore/Exception |
"readme":"compute/resource-manager/readme.md", "tag":"package-2021-03-01", "details":"Error: Plugin prechecker reported failure." |
️️✔️
[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
Swagger Generation Artifacts
|
Hi @basharg, Your PR has some issues. Please fix the CI sequentially by following the order of
|
specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/compute.json
Outdated
Show resolved
Hide resolved
specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/compute.json
Show resolved
Hide resolved
specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/compute.json
Outdated
Show resolved
Hide resolved
specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/compute.json
Outdated
Show resolved
Hide resolved
"deleteOption": { | ||
"type": "string", | ||
"description": "Specify what happens to the public IP address when the VM is deleted", | ||
"default": "Delete", |
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.
What do these defaults do?
Should this default to delete or null, what is best practice here?
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.
for VM with profile config, shouldn't the default be Delete?
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.
The default is delete on the server side.
In terms of client libraries I am not sure of the best practice, we should perhaps ask Adam and Jun
specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/compute.json
Outdated
Show resolved
Hide resolved
specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/compute.json
Outdated
Show resolved
Hide resolved
specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/compute.json
Outdated
Show resolved
Hide resolved
}, | ||
"deleteOption": { | ||
"type": "string", | ||
"default": "Delete", |
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.
Should the default be delete or null here as above
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.
default as delete for VM?
specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/compute.json
Outdated
Show resolved
Hide resolved
specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/compute.json
Show resolved
Hide resolved
specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/compute.json
Outdated
Show resolved
Hide resolved
specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/compute.json
Outdated
Show resolved
Hide resolved
specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/compute.json
Outdated
Show resolved
Hide resolved
Breaking changes reported in this PR are all accumulated from previous PRs, therefore those are fine to ignore |
specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/compute.json
Show resolved
Hide resolved
/azp run |
Azure Pipelines successfully started running 2 pipeline(s). |
The breaking changes for python are accumulated from previous PRs. |
/azp run |
Azure Pipelines successfully started running 2 pipeline(s). |
Hi, @basharg your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @yungezz |
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Please ensure to add changelog with this PR by answering the following questions.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.