Fixing the Default Error Response for 2020-06-01-preview APIs

mkarmark · Feb 3, 2021 · 0c7a261 · 0c7a261
1 parent 56348ad
commit 0c7a261
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 31 deletions.
diff --git a/...cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json b/...cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json
@@ -4215,7 +4215,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "#/definitions/DefaultErrorResponse"
+              "$ref": "#/definitions/CloudError"
             }
           }
         },
@@ -4251,7 +4251,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "#/definitions/DefaultErrorResponse"
+              "$ref": "#/definitions/CloudError"
             }
           }
         },
@@ -4293,7 +4293,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "#/definitions/DefaultErrorResponse"
+              "$ref": "#/definitions/CloudError"
             }
           }
         }
@@ -4470,26 +4470,39 @@
       },
       "description": "The List operation response, that contains the graphs and their properties."
     },
-    "ErrorResponse": {
+    "CloudError": {
+      "x-ms-external": true,
       "properties": {
-        "code": {
-          "description": "Error code.",
-          "type": "string"
-        },
-        "message": {
-          "description": "Error message indicating why the operation failed.",
-          "type": "string"
+        "error": {
+          "$ref": "#/definitions/CloudErrorBody"
         }
       },
-      "description": "Error Response."
+      "description": "An error response from the Storage service."
     },
-    "DefaultErrorResponse": {
-      "description": "An error response from the service.",
+    "CloudErrorBody": {
+      "x-ms-external": true,
       "properties": {
-        "error": {
-          "$ref": "#/definitions/ErrorResponse"
+        "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."
     },
     "FailoverPolicies": {
       "properties": {

diff --git a/...tion/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/rbac.json b/...tion/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/rbac.json
@@ -70,7 +70,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "cosmos-db.json#/definitions/DefaultErrorResponse"
+              "$ref": "cosmos-db.json#/definitions/CloudError"
             }
           }
         }
@@ -123,7 +123,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "cosmos-db.json#/definitions/DefaultErrorResponse"
+              "$ref": "cosmos-db.json#/definitions/CloudError"
             }
           }
         }
@@ -167,7 +167,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "cosmos-db.json#/definitions/DefaultErrorResponse"
+              "$ref": "cosmos-db.json#/definitions/CloudError"
             }
           }
         }
@@ -209,7 +209,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "cosmos-db.json#/definitions/DefaultErrorResponse"
+              "$ref": "cosmos-db.json#/definitions/CloudError"
             }
           }
         }
@@ -251,7 +251,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "cosmos-db.json#/definitions/DefaultErrorResponse"
+              "$ref": "cosmos-db.json#/definitions/CloudError"
             }
           }
         }
@@ -304,7 +304,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "cosmos-db.json#/definitions/DefaultErrorResponse"
+              "$ref": "cosmos-db.json#/definitions/CloudError"
             }
           }
         }
@@ -348,7 +348,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "cosmos-db.json#/definitions/DefaultErrorResponse"
+              "$ref": "cosmos-db.json#/definitions/CloudError"
             }
           }
         }
@@ -390,7 +390,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "cosmos-db.json#/definitions/DefaultErrorResponse"
+              "$ref": "cosmos-db.json#/definitions/CloudError"
             }
           }
         }

diff --git a/...osmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json b/...osmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/restorable.json
@@ -67,7 +67,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "../../preview/2020-06-01-preview/cosmos-db.json#/definitions/DefaultErrorResponse"
+              "$ref": "cosmos-db.json#/definitions/CloudError"
             }
           }
         },
@@ -112,7 +112,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "../../preview/2020-06-01-preview/cosmos-db.json#/definitions/DefaultErrorResponse"
+              "$ref": "cosmos-db.json#/definitions/CloudError"
             }
           }
         },
@@ -160,7 +160,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "../../preview/2020-06-01-preview/cosmos-db.json#/definitions/DefaultErrorResponse"
+              "$ref": "cosmos-db.json#/definitions/CloudError"
             }
           }
         },
@@ -202,7 +202,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "../../preview/2020-06-01-preview/cosmos-db.json#/definitions/DefaultErrorResponse"
+              "$ref": "cosmos-db.json#/definitions/CloudError"
             }
           }
         },
@@ -247,7 +247,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "../../preview/2020-06-01-preview/cosmos-db.json#/definitions/DefaultErrorResponse"
+              "$ref": "cosmos-db.json#/definitions/CloudError"
             }
           }
         },
@@ -295,7 +295,7 @@
           "default": {
             "description": "Error response describing why the operation failed.",
             "schema": {
-              "$ref": "../../preview/2020-06-01-preview/cosmos-db.json#/definitions/DefaultErrorResponse"
+              "$ref": "cosmos-db.json#/definitions/CloudError"
             }
           }
         },