From c165b376d5c3b7118bdb4291560d652aca4cd311 Mon Sep 17 00:00:00 2001 From: "Anjor S. Hemant" Date: Sat, 6 Feb 2021 00:39:50 -0800 Subject: [PATCH] Updating the error response class in Backup API Version 2021-01-01 (#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 --- .../stable/2021-01-01/bms.json | 138 ++++++++++++------ 1 file changed, 93 insertions(+), 45 deletions(-) diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-01-01/bms.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-01-01/bms.json index 04a766abaf13..e577faa65552 100644 --- a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-01-01/bms.json +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-01-01/bms.json @@ -367,7 +367,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -421,7 +421,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -769,7 +769,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -849,7 +849,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -919,7 +919,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -998,7 +998,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -1071,7 +1071,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -1148,7 +1148,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -1227,7 +1227,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -1283,7 +1283,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -1342,7 +1342,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -1404,7 +1404,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -1460,7 +1460,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -1520,7 +1520,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -1579,7 +1579,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -1641,7 +1641,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -1690,7 +1690,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -1752,7 +1752,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -1810,7 +1810,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -1859,7 +1859,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -1919,7 +1919,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -1977,7 +1977,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -2036,7 +2036,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -2106,7 +2106,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -2166,7 +2166,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -2224,7 +2224,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -2287,7 +2287,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -2356,7 +2356,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -2416,7 +2416,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -2480,7 +2480,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -2554,7 +2554,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -2630,7 +2630,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -2702,7 +2702,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -2775,7 +2775,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -2854,7 +2854,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -2924,7 +2924,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -2980,7 +2980,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -3036,7 +3036,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -3088,7 +3088,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -3147,7 +3147,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -3206,7 +3206,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -3262,7 +3262,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -3311,7 +3311,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -3386,7 +3386,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -3459,7 +3459,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/NewErrorResponse" + "$ref": "#/definitions/CloudError" } } }, @@ -3621,6 +3621,54 @@ } } }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "type": "object", + "$ref": "#/definitions/CloudErrorBody", + "description": "The error object." + } + }, + "description": "An error response from the Container Instance service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "readOnly": true, + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "description": "A list of additional details about the error." + }, + "additionalInfo": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorAdditionalInfo" + }, + "description": "The error additional info." + } + }, + "description": "An error response from the Container Instance service." + }, "NewErrorResponse": { "properties": { "error": {