-
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
Adding a new stable version 2023-01-01 (Taking changes from 2022-11-01-preview) #22071
Adding a new stable version 2023-01-01 (Taking changes from 2022-11-01-preview) #22071
Conversation
Hi, @Shashank1306s 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.4)] | new version | base version |
---|---|---|
dataprotection.json | 2023-01-01(370c0fd) | 2022-12-01(main) |
dataprotection.json | 2023-01-01(370c0fd) | 2022-11-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️
LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
compared tags (via openapi-validator v2.0.0) | new version | base version |
---|---|---|
package-2023-01 | package-2023-01(370c0fd) | default(main) |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌
ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
API Readiness check failed. Please make sure your service is deployed. |
"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.DataProtection' for api version '2023-01-01'. The supported api-versions are '2020-01-01-alpha, 2021-02-01-preview, 2021-06-01-preview, 2021-01-01, 2021-07-01, 2021-10-01-preview, 2021-12-01-preview, 2022-01-01, 2022-02-01-preview, 2022-03-01, 2022-04-01, 2022-05-01, 2022-09-01-preview, 2022-10-01-preview, 2022-11-01-preview, 2022-12-01'." |
️❌
~[Staging] ServiceAPIReadinessTest: 59 Errors, 0 Warnings failed [Detail]
Tag package-2023-01; Prod region: Not deployed; Canary region: Deployed
Test run on region: eastus2euap; Operation coverage: total: 61, untested: 0, failed: 59, passed: 2
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.DataProtection' for api version '2023-01-01'. The supported api-versions are '2020-01-01-alpha,2021-02-01-preview,2021-06-01-preview,2021-01-01,2021-07-01,2021-10-01-preview,2021-12-01-preview,2022-01-01,2022-02-01-preview,2022-03-01,2022-04-01,2022-05-01,2022-09-01-preview,2022-10-01-preview,2022-11-01-preview,2022-12-01'. Source: runtime OperationId: BackupVaults_CheckNameAvailability |
CLIENT_ERROR |
statusCode: 400, errorCode: NoRegisteredProviderFound, errorMessage: No registered resource provider found for location 'eastus2euap' and API version '2023-01-01' for type 'BackupVaults'. The supported api-versions are '2020-01-01-alpha, 2021-02-01-preview, 2021-06-01-preview, 2021-01-01, 2021-07-01, 2021-10-01-preview, 2021-12-01-preview, 2022-01-01, 2022-02-01-preview, 2022-03-01, 2022-04-01, 2022-05-01, 2022-09-01-preview, 2022-10-01-preview, 2022-11-01-preview, 2022-12-01'. The supported locations are 'southcentralus, eastus, eastus2, westus, uksouth, australiacentral, australiaeast, australiasoutheast, brazilsouth, canadacentral, canadaeast, centralus, eastasia, francecentral, germanywestcentral, centralindia, southindia, westindia, japaneast, japanwest, koreacentral, koreasouth, northcentralus, northeurope, norwayeast, southafricanorth, southeastasia, switzerlandnorth, uaenorth, ukwest, westcentralus, westeurope, westus2, jioindiawest, jioindiacentral, westus3, swedencentral, qatarcentral, centraluseuap, eastus2euap'. Source: runtime OperationId: BackupVaults_CreateOrUpdate |
CLIENT_ERROR |
statusCode: 404, errorCode: InvalidResourceType, errorMessage: The resource type 'BackupVaults' could not be found in the namespace 'Microsoft.DataProtection' for api version '2023-01-01'. The supported api-versions are '2020-01-01-alpha,2021-02-01-preview,2021-06-01-preview,2021-01-01,2021-07-01,2021-10-01-preview,2021-12-01-preview,2022-01-01,2022-02-01-preview,2022-03-01,2022-04-01,2022-05-01,2022-09-01-preview,2022-10-01-preview,2022-11-01-preview,2022-12-01'. Source: runtime OperationId: BackupVaults_GetInSubscription |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DataProtection/BackupVaults/vaultnam0lwet9' under resource group 'apiTest-SmjxMl-22071' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: BackupVaults_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: InvalidResourceType, errorMessage: The resource type 'BackupVaults' could not be found in the namespace 'Microsoft.DataProtection' for api version '2023-01-01'. The supported api-versions are '2020-01-01-alpha,2021-02-01-preview,2021-06-01-preview,2021-01-01,2021-07-01,2021-10-01-preview,2021-12-01-preview,2022-01-01,2022-02-01-preview,2022-03-01,2022-04-01,2022-05-01,2022-09-01-preview,2022-10-01-preview,2022-11-01-preview,2022-12-01'. Source: runtime OperationId: BackupVaults_GetInResourceGroup |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DataProtection/BackupVaults/vaultnam0lwet9' under resource group 'apiTest-SmjxMl-22071' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: BackupVaults_Update |
CLIENT_ERROR |
statusCode: 400, errorCode: NoRegisteredProviderFound, errorMessage: No registered resource provider found for location 'eastus2euap' and API version '2023-01-01' for type 'ResourceGuards'. The supported api-versions are '2021-02-01-preview, 2021-07-01, 2021-10-01-preview, 2021-12-01-preview, 2022-01-01, 2022-02-01-preview, 2022-03-01, 2022-04-01, 2022-05-01, 2022-09-01-preview, 2022-10-01-preview, 2022-11-01-preview, 2022-12-01'. The supported locations are 'eastus2, northeurope, southeastasia, westcentralus, southcentralus, eastus, westus, uksouth, australiacentral, australiaeast, australiasoutheast, brazilsouth, canadacentral, canadaeast, centralus, eastasia, francecentral, germanywestcentral, centralindia, southindia, westindia, japaneast, japanwest, koreacentral, koreasouth, northcentralus, norwayeast, southafricanorth, switzerlandnorth, uaenorth, ukwest, westeurope, westus2, jioindiawest, jioindiacentral, westus3, swedencentral, qatarcentral, centraluseuap, eastus2euap'. Source: runtime OperationId: ResourceGuards_Put |
CLIENT_ERROR |
statusCode: 404, errorCode: InvalidResourceType, errorMessage: The resource type 'ResourceGuards' could not be found in the namespace 'Microsoft.DataProtection' for api version '2023-01-01'. The supported api-versions are '2021-02-01-preview,2021-07-01,2021-10-01-preview,2021-12-01-preview,2022-01-01,2022-02-01-preview,2022-03-01,2022-04-01,2022-05-01,2022-09-01-preview,2022-10-01-preview,2022-11-01-preview,2022-12-01'. Source: runtime OperationId: ResourceGuards_GetResourcesInSubscription |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DataProtection/ResourceGuards/resource1ji54r' under resource group 'apiTest-SmjxMl-22071' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: ResourceGuards_GetDeleteProtectedItemRequestsObjects |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DataProtection/ResourceGuards/resource1ji54r' under resource group 'apiTest-SmjxMl-22071' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: ResourceGuards_GetDefaultBackupSecurityPINRequestsObject |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DataProtection/ResourceGuards/resource1ji54r' under resource group 'apiTest-SmjxMl-22071' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: ResourceGuards_GetUpdateProtectedItemRequestsObjects |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DataProtection/ResourceGuards/resource1ji54r' under resource group 'apiTest-SmjxMl-22071' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: ResourceGuards_GetDefaultUpdateProtectionPolicyRequestsObject |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DataProtection/ResourceGuards/resource1ji54r' under resource group 'apiTest-SmjxMl-22071' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: ResourceGuards_GetUpdateProtectionPolicyRequestsObjects |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DataProtection/ResourceGuards/resource1ji54r' under resource group 'apiTest-SmjxMl-22071' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: ResourceGuards_GetDefaultDisableSoftDeleteRequestsObject |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DataProtection/ResourceGuards/resource1ji54r' under resource group 'apiTest-SmjxMl-22071' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: ResourceGuards_GetBackupSecurityPINRequestsObjects |
CLIENT_ERROR |
statusCode: 404, errorCode: InvalidResourceType, errorMessage: The resource type 'ResourceGuards' could not be found in the namespace 'Microsoft.DataProtection' for api version '2023-01-01'. The supported api-versions are '2021-02-01-preview,2021-07-01,2021-10-01-preview,2021-12-01-preview,2022-01-01,2022-02-01-preview,2022-03-01,2022-04-01,2022-05-01,2022-09-01-preview,2022-10-01-preview,2022-11-01-preview,2022-12-01'. Source: runtime OperationId: ResourceGuards_GetResourcesInResourceGroup |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DataProtection/ResourceGuards/resource1ji54r' under resource group 'apiTest-SmjxMl-22071' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: ResourceGuards_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DataProtection/ResourceGuards/resource1ji54r' under resource group 'apiTest-SmjxMl-22071' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: ResourceGuards_GetDefaultDeleteResourceGuardProxyRequestsObject |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DataProtection/ResourceGuards/resource1ji54r' under resource group 'apiTest-SmjxMl-22071' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: ResourceGuards_GetDisableSoftDeleteRequestsObjects |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DataProtection/ResourceGuards/resource1ji54r' under resource group 'apiTest-SmjxMl-22071' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: ResourceGuards_GetDeleteResourceGuardProxyRequestsObjects |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DataProtection/ResourceGuards/resource1ji54r' under resource group 'apiTest-SmjxMl-22071' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: ResourceGuards_GetDefaultUpdateProtectedItemRequestsObject |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DataProtection/ResourceGuards/resource1ji54r' under resource group 'apiTest-SmjxMl-22071' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: ResourceGuards_GetDefaultDeleteProtectedItemRequestsObject |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DataProtection/ResourceGuards/resource1ji54r' under resource group 'apiTest-SmjxMl-22071' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: ResourceGuards_Patch |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DataProtection/BackupVaults/vaultnam0lwet9' under resource group 'apiTest-SmjxMl-22071' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: BackupInstances_CreateOrUpdate |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DataProtection/BackupVaults/vaultnam0lwet9' under resource group 'apiTest-SmjxMl-22071' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: BackupInstances_List |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DataProtection/BackupVaults/vaultnam0lwet9' under resource group 'apiTest-SmjxMl-22071' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: BackupInstances_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DataProtection/BackupVaults/vaultnam0lwet9' under resource group 'apiTest-SmjxMl-22071' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: BackupInstances_GetBackupInstanceOperationResult |
CLIENT_ERROR |
statusCode: 403, errorCode: LinkedAuthorizationFailed, errorMessage: The client '7904a8be-825f-480e-a728-80a70579dba4' with object id '7904a8be-825f-480e-a728-80a70579dba4' has permission to perform action 'Microsoft.DataProtection/backupVaults/backupInstances/restore/action' on scope '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5/resourceGroups/apiTest-SmjxMl-22071/providers/Microsoft.DataProtection/backupVaults/vaultnam0lwet9/backupInstances/backupinyaz7lp'; however, it does not have permission to perform action 'read' on the linked scope(s) '/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb' or the linked scope(s) are invalid. Source: runtime OperationId: BackupInstances_TriggerRestore |
CLIENT_ERROR |
statusCode: 403, errorCode: LinkedAuthorizationFailed, errorMessage: The client '7904a8be-825f-480e-a728-80a70579dba4' with object id '7904a8be-825f-480e-a728-80a70579dba4' has permission to perform action 'Microsoft.DataProtection/backupVaults/validateForBackup/action' on scope '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5/resourceGroups/apiTest-SmjxMl-22071/providers/Microsoft.DataProtection/backupVaults/vaultnam0lwet9'; however, it does not have permission to perform action 'read' on the linked scope(s) '/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest' or the linked scope(s) are invalid. Source: runtime OperationId: BackupInstances_ValidateForBackup |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DataProtection/BackupVaults/vaultnam0lwet9' under resource group 'apiTest-SmjxMl-22071' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: BackupInstances_SyncBackupInstance |
️️✔️
~[Staging] SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
~[Staging] CadlAPIView 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
|
Hi @Shashank1306s, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Hi, @Shashank1306s, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline |
Hi, @Shashank1306s your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
Error responses - use common types azure-rest-api-specs/specification/common-types/resource-management/v3/types.json Line 300 in be6cd9c
And ErrorDetail https://github.com/Azure/azure-rest-api-specs/blob/be6cd9ccfcb6ba08c1c206627026eabfbff31fc1/specification/common-types/resource-management/v3/types.json#LL258C21-L258C21 Refers to: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/dataprotection.json:3596 in 9edb210. [](commit_id = 9edb210, deletion_comment = False) |
e.g. what values are OK? Refers to: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/dataprotection.json:4450 in 112258d. [](commit_id = 112258d, deletion_comment = False) |
...taprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/dataprotection.json
Outdated
Show resolved
Hide resolved
...taprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/dataprotection.json
Show resolved
Hide resolved
...taprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/dataprotection.json
Outdated
Show resolved
Hide resolved
} | ||
], | ||
"responses": { | ||
"200": { |
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.
PUT request should be able to return 201 as well as 200 if it supports 'create or update'
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.
Addressed
...taprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/dataprotection.json
Show resolved
Hide resolved
} | ||
}, | ||
"responses": { | ||
"200": { |
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 also include a sample 201 response, since this is a create or update sample
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.
This operation is always performed in sync time
we do not support async operation for policy create/update.
hence 201 status code cannot be added in this case. No changes required in swagger
...taprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/dataprotection.json
Show resolved
Hide resolved
Hi, I've removed the changes that were causing linting errors, and will resolve the arm comments. |
Hi @Shashank1306s, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
Hi @Shashank1306s , please require breaking change review from breaking change review board. |
@xiaoxuqi-ms : can you pls review this PR now |
The apiReadinessCheck failed, pls make sure your service are deployed or you have a scheduled time to deploy. |
We have a scheduled time to deploy, we will start deploying our service by 25 Jan. |
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
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.