Fixing swagger correctness issue in BackupStatusResponse #25383
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
Next Steps to Merge |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| bms.json | 2023-04-01(e144e55) | 2023-04-01(main) |
| Rule | Message |
|---|---|
|
The new version has a new property 'protectedItemsCount' in response that was not found in the old version. New: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L10562:7 Old: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L10562:7 |
|
The new version has a new property 'acquireStorageAccountLock' in response that was not found in the old version. New: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L10562:7 Old: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L10562:7 |
️️✔️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.1.4) | new version | base version |
|---|---|---|
| package-2023-04 | package-2023-04(e144e55) | package-2023-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 |
|---|---|
|
The private endpoint API: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateLinkResources is missing. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L20 |
|
The private endpoint API: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateEndpointConnections is missing. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L20 |
|
The path for nested resource doest not meet the valid resource pattern. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L21 |
|
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig' Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L21 |
|
/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig has different responses for PUT/GET/PATCH operations. The PUT/GET/PATCH operations must have same schema response. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L21 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L21 |
|
The path segment Subscriptions should be subscriptions. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L21 |
|
The parameters:vaultName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L22 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L48 |
|
The parameters:vaultName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L65 |
|
Any Put MUST contain 200 and 201 return codes. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L97 |
|
The parameters:vaultName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L117 |
|
Synchronous PATCH must have 200 return code. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L117 |
|
Mark the top-level property 'location', specified in the patch operation body, as readOnly or immutable. You could also choose to remove it from the request payload of the Patch operation. These properties are not patchable. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L136 |
|
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupPreValidateProtection' Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L164 |
|
The path segment Subscriptions should be subscriptions. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L164 |
|
Operation is missing a default response. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L194 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L194 |
|
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupStatus' Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L209 |
|
The path segment Subscriptions should be subscriptions. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L209 |
|
Operation is missing a default response. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L239 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L239 |
|
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupValidateFeatures' Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L254 |
|
The path segment Subscriptions should be subscriptions. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L254 |
|
Operation is missing a default response. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L284 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L284 |
|
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/backupProtectionIntent/{intentObjectName}' Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L299 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L299 |
|
The resource name parameter 'fabricName' should be defined with a 'pattern' restriction. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L299 |
|
The resource name parameter 'intentObjectName' should be defined with a 'pattern' restriction. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L299 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView 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).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
AzureRestAPISpecReview
added
ARMChangesRequested
|
Please address or respond to feedback from the ARM API reviewer. |
This was referenced Aug 18, 2023
JeffreyRichter
added
the
Approved-BreakingChange
hiaga
removed
the
ARMChangesRequested
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
rkmanda
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
|
Please run pr /RequestMerge when you are ready for this to be merged as indicated in step 4 for the PR workflow diagram |
sjanamma
added
ARMSignedOff
|
/pr RequestMerge |
|
@hiaga Merge will still be handled by ARM team (non IDC) while the IDC team is ramping up. Please reach out to ARM reviewer for the same. |
|
Swagger pipeline restarted successfully, please wait for status update in this comment. |
jnlycklama
pushed a commit
that referenced
this pull request
Nov 8, 2023
Co-authored-by: Rohini Das <rodas@microsoft.com>
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.
ARM (Control Plane) API Specification Update Pull Request
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label
ARMChangesRequestedis removed from your PR. This should cause the label
WaitForARMFeedbackto be added.[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])
If you need further help with anything, see
Getting helpsection below.Purpose of this PR
What's the purpose of this PR? Check all that apply. This is mandatory!
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to Step 2, "ARM Review", for this PR.
Breaking changes review (Step 1)
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
ARM API changes review (Step 2)
ARMReviewlabel.Getting help
and https://aka.ms/ci-fix.