[Storage] move CloudError to common.json to resolve the duplicate s…

…chema issue (Azure#17336) * move cloud error to common.json * remove definition of Clouderror
LeiWang3 · Mar 31, 2022 · d7e1806 · d7e1806
1 parent 6205ca5
commit d7e1806
Show file tree

Hide file tree

Showing 5 changed files with 61 additions and 95 deletions.
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2021-08-01/blob.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2021-08-01/blob.json
@@ -867,7 +867,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "#/definitions/CloudError"
+              "$ref": "./common.json#/definitions/CloudError"
             }
           }
         },
@@ -1508,40 +1508,6 @@
         }
       },
       "description": "Lease Container response schema."
-    },
-    "CloudError": {
-      "x-ms-external": true,
-      "properties": {
-        "error": {
-          "$ref": "#/definitions/CloudErrorBody"
-        }
-      },
-      "description": "An error response from the Storage service."
-    },
-    "CloudErrorBody": {
-      "x-ms-external": true,
-      "properties": {
-        "code": {
-          "type": "string",
-          "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
-        },
-        "message": {
-          "type": "string",
-          "description": "A message describing the error, intended to be suitable for display in a user interface."
-        },
-        "target": {
-          "type": "string",
-          "description": "The target of the particular error. For example, the name of the property in error."
-        },
-        "details": {
-          "type": "array",
-          "items": {
-            "$ref": "#/definitions/CloudErrorBody"
-          },
-          "description": "A list of additional details about the error."
-        }
-      },
-      "description": "An error response from the Storage service."
     }
   },
   "parameters": {

diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2021-08-01/common.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2021-08-01/common.json
@@ -132,6 +132,40 @@
         "name": "SkuTier",
         "modelAsString": false
       }
+    },
+    "CloudError": {
+      "x-ms-external": true,
+      "properties": {
+        "error": {
+          "$ref": "#/definitions/CloudErrorBody"
+        }
+      },
+      "description": "An error response from the Storage service."
+    },
+    "CloudErrorBody": {
+      "x-ms-external": true,
+      "properties": {
+        "code": {
+          "type": "string",
+          "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
+        },
+        "message": {
+          "type": "string",
+          "description": "A message describing the error, intended to be suitable for display in a user interface."
+        },
+        "target": {
+          "type": "string",
+          "description": "The target of the particular error. For example, the name of the property in error."
+        },
+        "details": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/CloudErrorBody"
+          },
+          "description": "A list of additional details about the error."
+        }
+      },
+      "description": "An error response from the Storage service."
     }
   }
 }
diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2021-08-01/file.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2021-08-01/file.json
@@ -52,7 +52,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "#/definitions/CloudError"
+              "$ref": "./common.json#/definitions/CloudError"
             }
           }
         }
@@ -112,7 +112,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "#/definitions/CloudError"
+              "$ref": "./common.json#/definitions/CloudError"
             }
           }
         }
@@ -155,7 +155,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "#/definitions/CloudError"
+              "$ref": "./common.json#/definitions/CloudError"
             }
           }
         }
@@ -222,7 +222,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "#/definitions/CloudError"
+              "$ref": "./common.json#/definitions/CloudError"
             }
           }
         },
@@ -298,7 +298,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "#/definitions/CloudError"
+              "$ref": "./common.json#/definitions/CloudError"
             }
           }
         }
@@ -354,7 +354,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "#/definitions/CloudError"
+              "$ref": "./common.json#/definitions/CloudError"
             }
           }
         }
@@ -414,7 +414,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "#/definitions/CloudError"
+              "$ref": "./common.json#/definitions/CloudError"
             }
           }
         }
@@ -471,7 +471,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "#/definitions/CloudError"
+              "$ref": "./common.json#/definitions/CloudError"
             }
           }
         }
@@ -521,7 +521,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "#/definitions/CloudError"
+              "$ref": "./common.json#/definitions/CloudError"
             }
           }
         }
@@ -590,7 +590,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "#/definitions/CloudError"
+              "$ref": "./common.json#/definitions/CloudError"
             }
           }
         }
@@ -996,40 +996,6 @@
           "description": "List of abbreviated permissions."
         }
       }
-    },
-    "CloudError": {
-      "x-ms-external": true,
-      "properties": {
-        "error": {
-          "$ref": "#/definitions/CloudErrorBody"
-        }
-      },
-      "description": "An error response from the Storage service."
-    },
-    "CloudErrorBody": {
-      "x-ms-external": true,
-      "properties": {
-        "code": {
-          "type": "string",
-          "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
-        },
-        "message": {
-          "type": "string",
-          "description": "A message describing the error, intended to be suitable for display in a user interface."
-        },
-        "target": {
-          "type": "string",
-          "description": "The target of the particular error. For example, the name of the property in error."
-        },
-        "details": {
-          "type": "array",
-          "items": {
-            "$ref": "#/definitions/CloudErrorBody"
-          },
-          "description": "A list of additional details about the error."
-        }
-      },
-      "description": "An error response from the Storage service."
     }
   },
   "parameters": {

diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2021-08-01/queue.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2021-08-01/queue.json
@@ -52,7 +52,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "./file.json#/definitions/CloudError"
+              "$ref": "./common.json#/definitions/CloudError"
             }
           }
         }
@@ -106,7 +106,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "./file.json#/definitions/CloudError"
+              "$ref": "./common.json#/definitions/CloudError"
             }
           }
         }
@@ -149,7 +149,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "./file.json#/definitions/CloudError"
+              "$ref": "./common.json#/definitions/CloudError"
             }
           }
         }
@@ -206,7 +206,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "./file.json#/definitions/CloudError"
+              "$ref": "./common.json#/definitions/CloudError"
             }
           }
         }
@@ -258,7 +258,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "./file.json#/definitions/CloudError"
+              "$ref": "./common.json#/definitions/CloudError"
             }
           }
         }
@@ -301,7 +301,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "./file.json#/definitions/CloudError"
+              "$ref": "./common.json#/definitions/CloudError"
             }
           }
         }
@@ -341,7 +341,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "./file.json#/definitions/CloudError"
+              "$ref": "./common.json#/definitions/CloudError"
             }
           }
         }
@@ -395,7 +395,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "./file.json#/definitions/CloudError"
+              "$ref": "./common.json#/definitions/CloudError"
             }
           }
         },

diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2021-08-01/table.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2021-08-01/table.json
@@ -52,7 +52,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "./file.json#/definitions/CloudError"
+              "$ref": "./common.json#/definitions/CloudError"
             }
           }
         }
@@ -106,7 +106,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "./file.json#/definitions/CloudError"
+              "$ref": "./common.json#/definitions/CloudError"
             }
           }
         }
@@ -149,7 +149,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "./file.json#/definitions/CloudError"
+              "$ref": "./common.json#/definitions/CloudError"
             }
           }
         }
@@ -194,7 +194,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "./file.json#/definitions/CloudError"
+              "$ref": "./common.json#/definitions/CloudError"
             }
           }
         }
@@ -237,7 +237,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "./file.json#/definitions/CloudError"
+              "$ref": "./common.json#/definitions/CloudError"
             }
           }
         }
@@ -280,7 +280,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "./file.json#/definitions/CloudError"
+              "$ref": "./common.json#/definitions/CloudError"
             }
           }
         }
@@ -320,7 +320,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "./file.json#/definitions/CloudError"
+              "$ref": "./common.json#/definitions/CloudError"
             }
           }
         }
@@ -362,7 +362,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "./file.json#/definitions/CloudError"
+              "$ref": "./common.json#/definitions/CloudError"
             }
           }
         },