-
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
Fix the description of SKU in Microsoft.RecoveryServices #19646
Conversation
Hi, @asmaskar 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
|
compared swaggers (via Oad v0.9.6)] | new version | base version |
---|---|---|
vaults.json | 2022-04-01(f68f78d) | 2022-04-01(main) |
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v1.13.0) | new version | base version |
---|---|---|
package-2022-04 | package-2022-04(f68f78d) | package-2022-04(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
R4011 - DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.RecoveryServices/stable/2022-04-01/vaults.json#L459 |
R4018 - OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.RecoveryServices/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.RecoveryServices/stable/2022-04-01/vaults.json#L231 |
R4037 - MissingTypeObject |
The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.RecoveryServices/stable/2022-04-01/vaults.json#L1791 |
R4037 - MissingTypeObject |
The schema 'Error' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.RecoveryServices/stable/2022-04-01/vaults.json#L1801 |
R4037 - MissingTypeObject |
The schema 'ErrorAdditionalInfo' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.RecoveryServices/stable/2022-04-01/vaults.json#L1837 |
R4041 - XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.RecoveryServices/stable/2022-04-01/vaults.json#L935 |
R4041 - XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.RecoveryServices/stable/2022-04-01/vaults.json#L948 |
R4041 - XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.RecoveryServices/stable/2022-04-01/vaults.json#L1804 |
R4041 - XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.RecoveryServices/stable/2022-04-01/vaults.json#L1817 |
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.RecoveryServices/stable/2022-04-01/vaults.json#L977 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.RecoveryServices/stable/2022-04-01/vaults.json#L1191 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.RecoveryServices/stable/2022-04-01/vaults.json#L1264 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.RecoveryServices/stable/2022-04-01/vaults.json#L1571 |
|
The operation 'GetOperationResult' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Microsoft.RecoveryServices/stable/2022-04-01/vaults.json#L763 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateLinkResourcesModel'. Consider using the plural form of 'PrivateLinkResources' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.RecoveryServices/stable/2022-04-01/vaults.json#L27 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateLinkResourcesModel'. Consider using the plural form of 'PrivateLinkResources' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.RecoveryServices/stable/2022-04-01/vaults.json#L77 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'VaultExtendedInfoModel'. Consider using the plural form of 'VaultExtendedInfo' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.RecoveryServices/stable/2022-04-01/vaults.json#L559 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'VaultExtendedInfoModel'. Consider using the plural form of 'VaultExtendedInfo' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.RecoveryServices/stable/2022-04-01/vaults.json#L603 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'VaultExtendedInfoModel'. Consider using the plural form of 'VaultExtendedInfo' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.RecoveryServices/stable/2022-04-01/vaults.json#L659 |
|
The child tracked resource, 'operationResults' with immediate parent 'Vault', must have a list by immediate parent operation. Location: Microsoft.RecoveryServices/stable/2022-04-01/vaults.json#L1179 |
|
The child tracked resource, 'privateLinkResources' with immediate parent 'Vault', must have a list by immediate parent operation. Location: Microsoft.RecoveryServices/stable/2022-04-01/vaults.json#L1681 |
|
The child tracked resource, 'operationStatus' with immediate parent 'Vault', must have a list by immediate parent operation. Location: Microsoft.RecoveryServices/stable/2022-04-01/vaults.json#L1759 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: nameAvailable Location: Microsoft.RecoveryServices/stable/2022-04-01/vaults.json#L853 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: useSystemAssignedIdentity Location: Microsoft.RecoveryServices/stable/2022-04-01/vaults.json#L1749 |
|
'privateLinkResourceName' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.RecoveryServices/stable/2022-04-01/vaults.json#L94 |
|
'operationId' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.RecoveryServices/stable/2022-04-01/vaults.json#L731 |
|
'operationId' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.RecoveryServices/stable/2022-04-01/vaults.json#L782 |
|
The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation. Location: Microsoft.RecoveryServices/stable/2022-04-01/vaults.json#L6 |
|
The response of operation:'VaultExtendedInfo_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.RecoveryServices/stable/2022-04-01/vaults.json#L554 |
|
The response of operation:'VaultExtendedInfo_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.RecoveryServices/stable/2022-04-01/vaults.json#L598 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️⚠️
SDK Track2 Validation: 4 Warnings warning [Detail]
- The following tags are being changed in this PR
Rule | Message |
---|---|
"readme":"recoveryservices/resource-manager/readme.md", "tag":"package-2022-04", "details":"Semantic violation: Extension 'x-ms-code-generation-settings' is not supported in Autorest V3. It will just be ignored. (info > x-ms-code-generation-settings)" |
|
"readme":"recoveryservices/resource-manager/readme.md", "tag":"package-2022-04", "details":"Semantic violation: Extension 'x-ms-code-generation-settings' is not supported in Autorest V3. It will just be ignored. (info > x-ms-code-generation-settings)" |
|
"readme":"recoveryservices/resource-manager/readme.md", "tag":"package-2022-04", "details":"Semantic violation: Extension 'x-ms-code-generation-settings' is not supported in Autorest V3. It will just be ignored. (info > x-ms-code-generation-settings)" |
|
"readme":"recoveryservices/resource-manager/readme.md", "tag":"package-2022-04", "details":"Semantic violation: Extension 'x-ms-code-generation-settings' is not supported in Autorest V3. It will just be ignored. (info > x-ms-code-generation-settings)" |
|
💬 | "readme":"recoveryservices/resource-manager/readme.md", "tag":"package-2022-04", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0 -> 1.11.0)" |
💬 | "readme":"recoveryservices/resource-manager/readme.md", "tag":"package-2022-04", "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0->1.11.0)" |
💬 | "readme":"recoveryservices/resource-manager/readme.md", "tag":"package-2022-04", "details":"> Installing AutoRest extension '@autorest/modelerfour' (4.21.4 -> 4.21.4)" |
💬 | "readme":"recoveryservices/resource-manager/readme.md", "tag":"package-2022-04", "details":"> Installed AutoRest extension '@autorest/modelerfour' (4.21.4->4.21.4)" |
💬 | "readme":"recoveryservices/resource-manager/readme.md", "tag":"package-2022-04", "details":"Autorest completed in 12.42s. 0 files generated." |
The following errors/warnings exist before current PR submission:
|:speech_balloon: |"readme":"recoveryservices/resource-manager/readme.md",
"tag":"package-2022-04",
"details":"AutoRest core version selected from configuration: ^3.2.0."|
️️✔️
PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️
CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
Swagger Generation Artifacts
|
…RecoveryServices (#2451) Create to sync Azure/azure-rest-api-specs#19646 [ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/main...azure-sdk:sdkAuto/recoveryservices?expand=1)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for 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
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
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 any of the following scenarios apply to the PR, request approval from the 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.