DiskRP Swagger changes for 2020-12-01 #12796
Merged
Conversation
This file contains 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
meet1993shah
requested review from
dkulkarni-ms,
grizzlytheodore,
haagha,
hyonholee,
madewithsmiles,
MS-syh2qs and
Sandido
as code owners
|
Hi, @meet1993shah 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. [email protected] |
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: supportsHibernation Location: Microsoft.Compute/stable/2020-12-01/disk.json#L2023 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: supportsHibernation Location: Microsoft.Compute/stable/2020-12-01/disk.json#L2121 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: rotationToLatestKeyVersionEnabled Location: Microsoft.Compute/stable/2020-12-01/disk.json#L2162 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: supportsHibernation Location: Microsoft.Compute/stable/2020-12-01/disk.json#L2433 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: supportsHibernation Location: Microsoft.Compute/stable/2020-12-01/disk.json#L2474 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: rotationToLatestKeyVersionEnabled Location: Microsoft.Compute/stable/2020-12-01/disk.json#L2489 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: supportsHibernation Location: Microsoft.Compute/stable/2020-12-01/disk.json#L3217 |
|
| 'securityType' 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/2020-12-01/disk.json#L2700 |
|
| 'identity' 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/2020-12-01/disk.json#L2863 |
️⚠️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-2020-12-01 |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⚠️[Staging] Cross Version BreakingChange (Base on preview version): 18 Warnings warning [Detail]
Only 10 items are listed, please refer to log for more details.
- Compared Swaggers (Based on Oad v0.8.7)
- original: preview/2016-04-30-preview/disk.json <---> new: stable/2020-12-01/disk.json
️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
- Compared Swaggers (Based on Oad v0.8.7)
- original: stable/2020-09-30/disk.json <---> new: stable/2020-12-01/disk.json
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌[Staging] SDK Track2 Validation: 4 Errors, 609 Warnings failed [Detail]
Only 10 items are listed, please refer to log for more details.
- The following tags are being changed in this PR
| Rule | Message |
|---|---|
|
"readme":"compute/resource-manager/readme.md", "tag":"package-2020-12-01", "details":"Duplicate Schema named PurchasePlan -- properties.promotionCode: undefined => "description":"The Offer Promotion Code.", "$ref":"#/components/schemas/schemas:1247" ; 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." |
|
"readme":"compute/resource-manager/readme.md", "tag":"package-2020-12-01", "details":"Error: Plugin prechecker reported failure." |
|
"readme":"compute/resource-manager/readme.md", "tag":"package-2020-12-01-only", "details":"Duplicate Schema named PurchasePlan -- properties.promotionCode: "description":"The Offer Promotion Code.", "$ref":"#/components/schemas/schemas:89" => ; 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." |
|
"readme":"compute/resource-manager/readme.md", "tag":"package-2020-12-01-only", "details":"Error: Plugin prechecker reported failure." |
| "readme":"compute/resource-manager/readme.md", "tag":"package-2020-12-01", "details":"The schema 'ComputeOperationListResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"compute/resource-manager/readme.md", "tag":"package-2020-12-01", "details":"The schema 'ComputeOperationValue' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"compute/resource-manager/readme.md", "tag":"package-2020-12-01", "details":"The schema 'ComputeOperationValueDisplay' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"compute/resource-manager/readme.md", "tag":"package-2020-12-01", "details":"The schema 'DisallowedConfiguration' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"compute/resource-manager/readme.md", "tag":"package-2020-12-01", "details":"The schema 'RetrieveBootDiagnosticsDataResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"compute/resource-manager/readme.md", "tag":"package-2020-12-01", "details":"The schema 'InstanceViewStatus' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
Swagger Generation Artifacts
|
|
Hi @meet1993shah, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Feb 2, 2021
ArcturusZhang
added
the
DoNotMerge
This was referenced Mar 16, 2021
26 tasks
MirzaSikander
pushed a commit
to MirzaSikander/azure-rest-api-specs
that referenced
this pull request
Mar 22, 2021
* Initial commit * add autorotation properties * supportsHibernation property added * Update disk.json and add examples to support SSD ZRS managed disks. * Add a ref to the example. * adding new property - SecurityProfile * separate definition of SecurityType enum * fix identation * remove enum description * Improve descriptions for zrs. * address comments * added description for TrustedLaunch * using eastus2euap region in example * Revised descriptions of ssd zrs accounts * Add new property for Live tier change Adding a struct so that custoemrs can get the pending property updates for their managed disk. * Update example to use region west us * Updated example to add tier in 202 response. * address comment * changing region to NorthCentralUS * Addressed comments and updated the example * fix region in example file * Fixing some validation errors * Renaming SecurityProfile to DiskSecurityProfile in Definitions * Missed a $ sign before ref for an example * Fixing validation errors * adding identity to diskencrpytionset update props * Adding location in response * fixing validation errors due to SecurityType enum * Changing PurchasePlan to DiskPurchasePlan * adding SecurityProfile in GetManagerDiskInfo example file * fix tests by adding SecurityProfile in diskUpdateProperties * Changed ASSDZRS to SSDZRS * renamed the test to CreateAManagedDiskWithSSDZRSAccountType * Fix securitytype enum * addressing comment * fix typo * create enum def * Changing name from DiskSecurityProfile to ResourceSecurityProfile * Removing required from DiskSecurityProfile for securityType * Adding readOnly flag to true for privateEndpoint * reverted package-lock.json * reverting DiskPurchasePlan to PurchasePlan * Moving identity below tags in DiskEncryptionSetUpdate * Removing the extra ',' * changing PurchasePlan to DiskPurchasePlan and adding x-ms-client-name tag * Reverting back from DiskPurchasePlan to PurchasePlan Co-authored-by: Meet Shah <[email protected]> Co-authored-by: Hyuk Jun Park <[email protected]> Co-authored-by: LU WU <[email protected]> Co-authored-by: Anshul <[email protected]> Co-authored-by: rahul602 <[email protected]>
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
* Initial commit * add autorotation properties * supportsHibernation property added * Update disk.json and add examples to support SSD ZRS managed disks. * Add a ref to the example. * adding new property - SecurityProfile * separate definition of SecurityType enum * fix identation * remove enum description * Improve descriptions for zrs. * address comments * added description for TrustedLaunch * using eastus2euap region in example * Revised descriptions of ssd zrs accounts * Add new property for Live tier change Adding a struct so that custoemrs can get the pending property updates for their managed disk. * Update example to use region west us * Updated example to add tier in 202 response. * address comment * changing region to NorthCentralUS * Addressed comments and updated the example * fix region in example file * Fixing some validation errors * Renaming SecurityProfile to DiskSecurityProfile in Definitions * Missed a $ sign before ref for an example * Fixing validation errors * adding identity to diskencrpytionset update props * Adding location in response * fixing validation errors due to SecurityType enum * Changing PurchasePlan to DiskPurchasePlan * adding SecurityProfile in GetManagerDiskInfo example file * fix tests by adding SecurityProfile in diskUpdateProperties * Changed ASSDZRS to SSDZRS * renamed the test to CreateAManagedDiskWithSSDZRSAccountType * Fix securitytype enum * addressing comment * fix typo * create enum def * Changing name from DiskSecurityProfile to ResourceSecurityProfile * Removing required from DiskSecurityProfile for securityType * Adding readOnly flag to true for privateEndpoint * reverted package-lock.json * reverting DiskPurchasePlan to PurchasePlan * Moving identity below tags in DiskEncryptionSetUpdate * Removing the extra ',' * changing PurchasePlan to DiskPurchasePlan and adding x-ms-client-name tag * Reverting back from DiskPurchasePlan to PurchasePlan Co-authored-by: Meet Shah <[email protected]> Co-authored-by: Hyuk Jun Park <[email protected]> Co-authored-by: LU WU <[email protected]> Co-authored-by: Anshul <[email protected]> Co-authored-by: rahul602 <[email protected]>
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.
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 API 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.
SDK PR - Azure/azure-sdk-for-net#19092