{AzureDataProtection} fixes Azure/azure-rest-api-specs#21183 #21551
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
fixes #21183 The enum values for the storage settings are listed in the latest API as `ArchiveStore, SnapshotStore, VaultStore.` However while providing `SnapshotStore` value it fail with `BMSUserErrorInvalidInput` error. Also while trying the same from PS cmdlet using > New-AzDataProtectionBackupVaultStorageSettingObject -DataStoreType SnapshotStore -Type LocallyRedundant **Error:** ``` Error: "Unable to match the identifier name SnapshotStore to a valid enumerator name. Specify one of the following enumerator names and try again: ArchiveStore, OperationalStore, VaultStore" ``` This PR fixes the enum value of storage setting
|
Hi, @navba-MSFT 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 |
|---|---|---|
| dataprotection.json | 2022-05-01(42afe6f) | 2022-05-01(main) |
| Rule | Message |
|---|---|
|
The new version is removing enum value(s) 'SnapshotStore' from the old version. New: Microsoft.DataProtection/stable/2022-05-01/dataprotection.json#L6112:9 Old: Microsoft.DataProtection/stable/2022-05-01/dataprotection.json#L6112:9 |
️️✔️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 v2.0.0) | new version | base version |
|---|---|---|
| package-2022-05 | package-2022-05(42afe6f) | package-2022-05(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The parameters:operationId,location should be kept in the same order as they present in the path. Location: Microsoft.DataProtection/stable/2022-05-01/dataprotection.json#L64 |
|
The get operation should only return 200. Location: Microsoft.DataProtection/stable/2022-05-01/dataprotection.json#L94 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2022-05-01/dataprotection.json#L184 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2022-05-01/dataprotection.json#L328 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DataProtection/stable/2022-05-01/dataprotection.json#L375 |
|
An async DELETE operation must set ''x-ms-long-running-operation' : true''. Location: Microsoft.DataProtection/stable/2022-05-01/dataprotection.json#L440 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DataProtection/stable/2022-05-01/dataprotection.json#L440 |
|
A 202 response should include an Location response header. Location: Microsoft.DataProtection/stable/2022-05-01/dataprotection.json#L467 |
|
A 202 response should include an Location response header. Location: Microsoft.DataProtection/stable/2022-05-01/dataprotection.json#L525 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2022-05-01/dataprotection.json#L543 |
|
The get operation should only return 200. Location: Microsoft.DataProtection/stable/2022-05-01/dataprotection.json#L579 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2022-05-01/dataprotection.json#L760 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2022-05-01/dataprotection.json#L808 |
|
The resource name parameter 'backupPolicyName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2022-05-01/dataprotection.json#L808 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2022-05-01/dataprotection.json#L968 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2022-05-01/dataprotection.json#L1016 |
|
The resource name parameter 'backupInstanceName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2022-05-01/dataprotection.json#L1016 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DataProtection/stable/2022-05-01/dataprotection.json#L1067 |
|
Only 201 is the supported response code for PUT async response. Location: Microsoft.DataProtection/stable/2022-05-01/dataprotection.json#L1119 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DataProtection/stable/2022-05-01/dataprotection.json#L1146 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2022-05-01/dataprotection.json#L1216 |
|
The resource name parameter 'backupInstanceName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2022-05-01/dataprotection.json#L1216 |
|
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DataProtection/stable/2022-05-01/dataprotection.json#L1217 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2022-05-01/dataprotection.json#L1296 |
|
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DataProtection/stable/2022-05-01/dataprotection.json#L1297 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2022-05-01/dataprotection.json#L1369 |
|
The resource name parameter 'backupInstanceName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2022-05-01/dataprotection.json#L1369 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'BackupInstances' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DataProtection/stable/2022-05-01/dataprotection.json#L1375 |
|
The get operation should only return 200. Location: Microsoft.DataProtection/stable/2022-05-01/dataprotection.json#L1412 |
|
A 202 response should include an Location response header. Location: Microsoft.DataProtection/stable/2022-05-01/dataprotection.json#L1412 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️~[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
|
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
|
Hi @navba-MSFT, 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. |
This was referenced Nov 15, 2022
|
@umpatel Could you please review this PR once you get a chance ? |
JeffreyRichter
added
the
Approved-BreakingChange
xiaoxuqi-ms
approved these changes
Nov 28, 2022
This was referenced Nov 28, 2022
anandanthony
pushed a commit
to anandMicro/azure-rest-api-specs
that referenced
this pull request
Dec 16, 2022
fixes Azure#21183 The enum values for the storage settings are listed in the latest API as `ArchiveStore, SnapshotStore, VaultStore.` However while providing `SnapshotStore` value it fail with `BMSUserErrorInvalidInput` error. Also while trying the same from PS cmdlet using > New-AzDataProtectionBackupVaultStorageSettingObject -DataStoreType SnapshotStore -Type LocallyRedundant **Error:** ``` Error: "Unable to match the identifier name SnapshotStore to a valid enumerator name. Specify one of the following enumerator names and try again: ArchiveStore, OperationalStore, VaultStore" ``` This PR fixes the enum value of storage setting
kayousef-zz
pushed a commit
to kayousef-zz/azure-rest-api-specs
that referenced
this pull request
Dec 21, 2022
fixes Azure#21183 The enum values for the storage settings are listed in the latest API as `ArchiveStore, SnapshotStore, VaultStore.` However while providing `SnapshotStore` value it fail with `BMSUserErrorInvalidInput` error. Also while trying the same from PS cmdlet using > New-AzDataProtectionBackupVaultStorageSettingObject -DataStoreType SnapshotStore -Type LocallyRedundant **Error:** ``` Error: "Unable to match the identifier name SnapshotStore to a valid enumerator name. Specify one of the following enumerator names and try again: ArchiveStore, OperationalStore, VaultStore" ``` This PR fixes the enum value of storage setting
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.
fixes #21183
The enum values for the storage settings are listed in the latest API as
ArchiveStore, SnapshotStore, VaultStore.However while providing
SnapshotStorevalue it fail withBMSUserErrorInvalidInputerror. Also while trying the same from PS cmdlet usingError:
This PR fixes the enum value of storage setting
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.