Updating the error response class in Backup API Version 2021-01-01 #12872
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
|
Hi, @anjorsh 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. vsswagger@microsoft.com |
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
The new version has a different type '' than the previous one 'object'. New: Microsoft.RecoveryServices/stable/2021-01-01/bms.json#L3627:9 Old: Microsoft.RecoveryServices/stable/2021-01-01/bms.json#L3626:9 |
|
The new version is missing a property found in the old version. Was 'error' renamed or removed? New: Microsoft.RecoveryServices/stable/2021-01-01/bms.json#L3637:7 Old: Microsoft.RecoveryServices/stable/2021-01-01/bms.json#L3625:7 |
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/recoveryservicesbackup/resource-manager/readme.md tag: specification/recoveryservicesbackup/resource-manager/readme.md#tag-package-2021-01 |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌[Staging] SDK Track2 Validation: 13 Errors, 27 Warnings failed [Detail]
Only 10 items are listed, please refer to log for more details.
- The following tags are being changed in this PR
| Rule | Message |
|---|---|
|
"readme":"recoveryservicesbackup/resource-manager/readme.md", "tag":"package-2021-01", "details":"Duplicate Schema named NewErrorResponse -- properties.error.$ref: undefined => "#/components/schemas/schemas:925" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"recoveryservicesbackup/resource-manager/readme.md", "tag":"package-2021-01", "details":"Duplicate Schema named NewErrorResponse-error -- properties.details.$ref: undefined => "#/components/schemas/schemas:929" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"recoveryservicesbackup/resource-manager/readme.md", "tag":"package-2021-01", "details":"Duplicate Schema named AzureFileshareProtectedItem -- properties.healthStatus: undefined => "description":"backups running status for this backup item.", "$ref":"#/components/schemas/HealthStatus" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"recoveryservicesbackup/resource-manager/readme.md", "tag":"package-2021-01", "details":"Duplicate Schema named AzureFileShareRecoveryPoint -- properties.recoveryPointType.$ref: undefined => "#/components/schemas/schemas:952", properties.recoveryPointType.readOnly: undefined => true, properties.recoveryPointTime.$ref: undefined => "#/components/schemas/schemas:953", properties.recoveryPointTime.readOnly: undefined => true, properties.fileShareSnapshotUri.$ref: undefined => "#/components/schemas/schemas:954", properties.fileShareSnapshotUri.readOnly: undefined => true, properties.recoveryPointSizeInGB.readOnly: undefined => true ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"recoveryservicesbackup/resource-manager/readme.md", "tag":"package-2021-01", "details":"Duplicate Schema named AzureWorkloadPointInTimeRecoveryPoint -- allOf.0.$ref: undefined => "#/components/schemas/schemas:1079" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"recoveryservicesbackup/resource-manager/readme.md", "tag":"package-2021-01", "details":"Duplicate Schema named AzureWorkloadRecoveryPoint -- properties.recoveryPointTimeInUTC.$ref: undefined => "#/components/schemas/schemas:1080", properties.recoveryPointTimeInUTC.readOnly: undefined => true, properties.type.readOnly: undefined => true ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"recoveryservicesbackup/resource-manager/readme.md", "tag":"package-2021-01", "details":"Duplicate Schema named AzureWorkloadSAPHanaPointInTimeRecoveryPoint -- allOf.0.$ref: undefined => "#/components/schemas/schemas:1075" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"recoveryservicesbackup/resource-manager/readme.md", "tag":"package-2021-01", "details":"Duplicate Schema named AzureWorkloadSAPHanaRecoveryPoint -- allOf.0.$ref: undefined => "#/components/schemas/schemas:1079" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"recoveryservicesbackup/resource-manager/readme.md", "tag":"package-2021-01", "details":"Duplicate Schema named AzureWorkloadSQLPointInTimeRecoveryPoint -- allOf.0.$ref: undefined => "#/components/schemas/schemas:1099" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"recoveryservicesbackup/resource-manager/readme.md", "tag":"package-2021-01", "details":"Duplicate Schema named AzureWorkloadSQLRecoveryPoint -- allOf.0.$ref: undefined => "#/components/schemas/schemas:1079", properties.extendedInfo.$ref: undefined => "#/components/schemas/schemas:1100" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
Swagger Generation Artifacts
|
|
Hi @anjorsh, 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 Feb 5, 2021
|
Hi @anjorsh, Your PR has some issues. Please fix the CI sequentially by following the order of
|
jorgecotillo
added
the
ARMSignedOff
akning-ms
reviewed
Feb 6, 2021
| @@ -3621,6 +3621,54 @@ | |||
| } | |||
| } | |||
| }, | |||
| "CloudError": { | |||
There was a problem hiding this comment.
will it be better to ref ErrorResponse? in ./common-types/resource-management/v2/types.json#
akning-ms
approved these changes
Feb 6, 2021
akning-ms
added
the
Approved-BreakingChange
This was referenced Feb 6, 2021
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
…zure#12872) * Updating the error response class in Backup API Version 2021-01-01 * Updating definition of CloudError * Using ARM error class for ErrorDetail * Copying NewErrorResponse as CloudError * Updating CloudError object * Marking properties as ReadOnly * Added Error Description and AdditionalInfo * Fixing Prettier issue * Added object type for Error * Updated error object description
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.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Please ensure to add changelog with 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
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please 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 there are following updates in the PR, ensure to request an approval from API 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.