-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
[Hub Generated] Review request for Microsoft.RecoveryServices to add version stable/2022-10-01 #21448
[Hub Generated] Review request for Microsoft.RecoveryServices to add version stable/2022-10-01 #21448
Conversation
…w/2022-09-30-preview to version 2022-10-01
Hi, @shesamian 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. vscswagger@microsoft.com |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.2)] | new version | base version |
---|---|---|
registeredidentities.json | 2022-10-01(cb2f819) | 2022-09-10(main) |
registeredidentities.json | 2022-10-01(cb2f819) | 2022-09-30-preview(main) |
replicationusages.json | 2022-10-01(cb2f819) | 2022-09-10(main) |
replicationusages.json | 2022-10-01(cb2f819) | 2022-09-30-preview(main) |
vaults.json | 2022-10-01(cb2f819) | 2022-09-10(main) |
vaults.json | 2022-10-01(cb2f819) | 2022-09-30-preview(main) |
vaultusages.json | 2022-10-01(cb2f819) | 2022-09-10(main) |
vaultusages.json | 2022-10-01(cb2f819) | 2022-09-30-preview(main) |
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 2 Warnings warning [Detail]
compared tags (via openapi-validator v2.0.0) | new version | base version |
---|---|---|
package-2022-10 | package-2022-10(cb2f819) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.RecoveryServices/stable/2022-10-01/vaults.json#L944 |
||
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.RecoveryServices/stable/2022-10-01/vaults.json#L958 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/certificates/{certificateName}' Location: Microsoft.RecoveryServices/stable/2022-10-01/registeredidentities.json#L21 |
ResourceNameRestriction |
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.RecoveryServices/stable/2022-10-01/registeredidentities.json#L21 |
ResourceNameRestriction |
The resource name parameter 'certificateName' should be defined with a 'pattern' restriction. Location: Microsoft.RecoveryServices/stable/2022-10-01/registeredidentities.json#L21 |
SubscriptionsAndResourceGroupCasing |
The path segment Subscriptions should be subscriptions. Location: Microsoft.RecoveryServices/stable/2022-10-01/registeredidentities.json#L21 |
RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.RecoveryServices/stable/2022-10-01/registeredidentities.json#L64 |
PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/registeredIdentities/{identityName}' Location: Microsoft.RecoveryServices/stable/2022-10-01/registeredidentities.json#L80 |
ResourceNameRestriction |
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.RecoveryServices/stable/2022-10-01/registeredidentities.json#L80 |
ResourceNameRestriction |
The resource name parameter 'identityName' should be defined with a 'pattern' restriction. Location: Microsoft.RecoveryServices/stable/2022-10-01/registeredidentities.json#L80 |
SubscriptionsAndResourceGroupCasing |
The path segment Subscriptions should be subscriptions. Location: Microsoft.RecoveryServices/stable/2022-10-01/registeredidentities.json#L80 |
DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.RecoveryServices/stable/2022-10-01/registeredidentities.json#L108 |
RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.RecoveryServices/stable/2022-10-01/registeredidentities.json#L108 |
DefinitionsPropertiesNamesCamelCase |
Property name should be camel case. Location: Microsoft.RecoveryServices/stable/2022-10-01/registeredidentities.json#L243 |
NestedResourcesMustHaveListOperation |
The nested resource 'VaultCertificateResponse' does not have list operation, please add it. Location: Microsoft.RecoveryServices/stable/2022-10-01/registeredidentities.json#L300 |
XmsParameterLocation |
The parameter 'SubscriptionId' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.RecoveryServices/stable/2022-10-01/registeredidentities.json#L327 |
XmsParameterLocation |
The parameter 'ApiVersion' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.RecoveryServices/stable/2022-10-01/registeredidentities.json#L350 |
PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/replicationUsages' Location: Microsoft.RecoveryServices/stable/2022-10-01/replicationusages.json#L21 |
ResourceNameRestriction |
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.RecoveryServices/stable/2022-10-01/replicationusages.json#L21 |
SubscriptionsAndResourceGroupCasing |
The path segment Subscriptions should be subscriptions. Location: Microsoft.RecoveryServices/stable/2022-10-01/replicationusages.json#L21 |
RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.RecoveryServices/stable/2022-10-01/replicationusages.json#L45 |
IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/stable/2022-10-01/replicationusages.json#L70 |
IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/stable/2022-10-01/replicationusages.json#L74 |
IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/stable/2022-10-01/replicationusages.json#L78 |
IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/stable/2022-10-01/replicationusages.json#L88 |
IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/stable/2022-10-01/replicationusages.json#L92 |
IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/stable/2022-10-01/replicationusages.json#L96 |
IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/stable/2022-10-01/replicationusages.json#L100 |
IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/stable/2022-10-01/replicationusages.json#L104 |
IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/stable/2022-10-01/replicationusages.json#L108 |
IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/stable/2022-10-01/replicationusages.json#L126 |
IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/stable/2022-10-01/replicationusages.json#L130 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️❌
~[Staging] ServiceAPIReadinessTest: 31 Errors, 0 Warnings failed [Detail]
Tag package-2022-10; Prod region: Deployed
Test run on region: westcentralus; Operation coverage: total: 20, untested: 0, failed: 13, passed: 7
Service API Readiness Test failed. Check pipeline artifact for detail report.
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
CLIENT_ERROR |
"statusCode: 404, errorCode: InvalidResourceType, errorMessage: The resource type 'locations/checkNameAvailability' could not be found in the namespace 'Microsoft.RecoveryServices' for api version '2022-10-01'. The supported api-versions are '2018-01-10'." |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: identityUrl" |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: identityUrl" |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: location" |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: tags" |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: identity" |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: sku" |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: location" |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: tags" |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: identity" |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: sku" |
CLIENT_ERROR |
"statusCode: 412, errorCode: undefined, errorMessage: undefined" |
INVALID_RESPONSE_BODY |
"Body is required in response but not provided" |
CLIENT_ERROR |
"statusCode: 400, errorCode: undefined, errorMessage: undefined" |
INVALID_RESPONSE_CODE |
"The swagger file does not define '400' response code" |
CLIENT_ERROR |
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: Could not perform the operation as VM no longer exists. Stop protecting virtual machine without deleting backup data. More details at http://go.microsoft.com/fwlink/?LinkId=808124 " |
INVALID_RESPONSE_CODE |
"The swagger file does not define '404' response code" |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: monitoringSummary" |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: jobsSummary" |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: protectedItemsSummary" |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: storageAccountsCountSummary" |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: protectedItemCount" |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: registeredServersCount" |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: recoveryPlanCount" |
CLIENT_ERROR |
"statusCode: 403, errorCode: AuthorizationFailed, errorMessage: The client '7904a8be-825f-480e-a728-80a70579dba4' with object id '7904a8be-825f-480e-a728-80a70579dba4' does not have authorization to perform action 'Microsoft.RecoveryServices/locations/capabilities/action' over scope '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5' or the scope is invalid. If access was recently granted, please refresh your credentials." |
SERVER_ERROR |
"statusCode: 500, errorCode: CloudInternalError, errorMessage: Microsoft Azure Backup encountered an internal error. Wait for a few minutes and then try the operation again. If the issue persists, please contact Microsoft support." |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: innerError" |
SERVER_ERROR |
"statusCode: 500, errorCode: CloudInternalError, errorMessage: Microsoft Azure Backup encountered an internal error. Wait for a few minutes and then try the operation again. If the issue persists, please contact Microsoft support." |
OBJECT_ADDITIONAL_PROPERTIES |
"Additional properties not allowed: innerError" |
CLIENT_ERROR |
"statusCode: 404, errorCode: undefined, errorMessage: undefined" |
️️✔️
~[Staging] SwaggerAPIView 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.
️️✔️
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.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
"swagger": "2.0", | ||
"info": { | ||
"version": "2022-10-01", | ||
"title": "RecoveryServicesClient", |
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.
Is not clear what new changes are being introduced with this API version.
The first commit needs to be the previous api version and the new changes should only be added in the subsequent commits. This is explained in detail here (If using Open API which is recommended) https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/208/OpenAPI-Hub-Adding-new-API-version or here(For manual process) : https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/83/Manual-Process-Adding-new-API-version . Please remove the "ARMChangesRequested" label once you have fixed this issue.
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.
Hi @rkmanda, thank you so much for the review.
-
The first commit is indeed generated by the OpenAPI Hub.
-
There are no significant changes because it's just for complaint. The actual changes were done in
recoveryservicessiterecovery
PR: [Hub Generated] Review request for Microsoft.RecoveryServices to add version stable/2022-10-01 #20998
This PR along with recoveryservicesbackup
are just for compliance.
3 PRs: https://github.com/Azure/azure-rest-api-specs/pulls/shesamian
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
/azp run |
Commenter does not have sufficient privileges for PR 21448 in repo Azure/azure-rest-api-specs |
...n/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2022-10-01/vaults.json
Outdated
Show resolved
Hide resolved
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.
I literally can't see any changes for ARM to approve at this point, so I guess this is approved. |
/azp run |
Commenter does not have sufficient privileges for PR 21448 in repo Azure/azure-rest-api-specs |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
Synced up with @shesamian offline, he created work item in backlog to investigate the API readiness test failures so that the production release won't be blocked. |
…soft.RecoveryServices to add version stable/2022-10-01 (#2673) Create to sync Azure/azure-rest-api-specs#21448 [ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/main...azure-sdk:sdkAuto/recoveryservices?expand=1)
…version stable/2022-10-01 (Azure#21448) * Adds base for updating Microsoft.RecoveryServices from version preview/2022-09-30-preview to version 2022-10-01 * Updates readme * Updates API version in new specs and examples * Minor markdown linting issue * Modified the formatting * used common parameters
…version stable/2022-10-01 (Azure#21448) * Adds base for updating Microsoft.RecoveryServices from version preview/2022-09-30-preview to version 2022-10-01 * Updates readme * Updates API version in new specs and examples * Minor markdown linting issue * Modified the formatting * used common parameters
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM API Information (Control Plane)
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
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 apply 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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.