From c44cc7877fc90a81e1ab52840548125a1ac56b96 Mon Sep 17 00:00:00 2001 From: Jiacheng Liu Date: Mon, 18 Jan 2021 00:56:09 -0800 Subject: [PATCH 1/3] Add missing default error responses --- .../stable/2019-09-01/keyvault.json | 30 +++++++++++++++++++ .../stable/2019-09-01/providers.json | 29 ++++++++++++++++++ 2 files changed, 59 insertions(+) diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2019-09-01/keyvault.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2019-09-01/keyvault.json index a57bc8f2e040..006d6be9695a 100644 --- a/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2019-09-01/keyvault.json +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2019-09-01/keyvault.json @@ -443,6 +443,12 @@ "schema": { "$ref": "#/definitions/VaultListResult" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-pageable": { @@ -489,6 +495,12 @@ "schema": { "$ref": "#/definitions/VaultListResult" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-pageable": { @@ -528,6 +540,12 @@ "schema": { "$ref": "#/definitions/DeletedVaultListResult" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-pageable": { @@ -719,6 +737,12 @@ "schema": { "$ref": "#/definitions/ResourceListResult" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-pageable": { @@ -764,6 +788,12 @@ "schema": { "$ref": "#/definitions/CheckNameAvailabilityResult" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-examples": { diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2019-09-01/providers.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2019-09-01/providers.json index d1f28d8f5599..163bf0d79f95 100644 --- a/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2019-09-01/providers.json +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2019-09-01/providers.json @@ -34,6 +34,12 @@ "schema": { "$ref": "#/definitions/OperationListResult" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-pageable": { @@ -152,6 +158,29 @@ "description": "Blob duration of specification." } } + }, + "ProviderError": { + "description": "An error response from Key Vault resource provider", + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "x-ms-external": true + }, + "ProviderErrorBody": { + "description": "An error response from Key Vault resource provider", + "properties": { + "code": { + "type": "string", + "description": "Error code. This is a mnemonic that can be consumed programmatically." + }, + "message": { + "type": "string", + "description": "User friendly error message. The message is typically localized and may vary with service version." + } + }, + "x-ms-external": true } }, "parameters": { From 0ecad92c69ca53ea078766f1a46410066281714c Mon Sep 17 00:00:00 2001 From: Jiacheng Liu Date: Mon, 18 Jan 2021 03:02:22 -0800 Subject: [PATCH 2/3] fix copy/paste error --- .../Microsoft.KeyVault/stable/2019-09-01/providers.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2019-09-01/providers.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2019-09-01/providers.json index 163bf0d79f95..8a97bdd34cb8 100644 --- a/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2019-09-01/providers.json +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2019-09-01/providers.json @@ -38,7 +38,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/CloudError" + "$ref": "#/definitions/ProviderError" } } }, @@ -163,7 +163,7 @@ "description": "An error response from Key Vault resource provider", "properties": { "error": { - "$ref": "#/definitions/CloudErrorBody" + "$ref": "#/definitions/ProviderErrorBody" } }, "x-ms-external": true From e28e1356759a071537adb961b4367b182311a18a Mon Sep 17 00:00:00 2001 From: Jiacheng Liu Date: Wed, 27 Jan 2021 01:04:42 -0800 Subject: [PATCH 3/3] unify the error model --- .../stable/2019-09-01/providers.json | 8 ++--- .../stable/2019-09-01/secrets.json | 34 +++++++++++-------- 2 files changed, 23 insertions(+), 19 deletions(-) diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2019-09-01/providers.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2019-09-01/providers.json index 8a97bdd34cb8..8dc2cf818c97 100644 --- a/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2019-09-01/providers.json +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2019-09-01/providers.json @@ -38,7 +38,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ProviderError" + "$ref": "#/definitions/CloudError" } } }, @@ -159,16 +159,16 @@ } } }, - "ProviderError": { + "CloudError": { "description": "An error response from Key Vault resource provider", "properties": { "error": { - "$ref": "#/definitions/ProviderErrorBody" + "$ref": "#/definitions/CloudErrorBody" } }, "x-ms-external": true }, - "ProviderErrorBody": { + "CloudErrorBody": { "description": "An error response from Key Vault resource provider", "properties": { "code": { diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2019-09-01/secrets.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2019-09-01/secrets.json index 69bd1c38e79a..64a05998bf50 100644 --- a/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2019-09-01/secrets.json +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2019-09-01/secrets.json @@ -73,7 +73,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ResponseError" + "$ref": "#/definitions/CloudError" } } }, @@ -151,7 +151,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ResponseError" + "$ref": "#/definitions/CloudError" } } }, @@ -212,7 +212,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ResponseError" + "$ref": "#/definitions/CloudError" } } }, @@ -291,21 +291,25 @@ } }, "definitions": { - "ResponseError": { + "CloudError": { "description": "An error response from Key Vault resource provider", "properties": { "error": { - "description": "An error response from Key Vault resource provider", - "properties": { - "code": { - "type": "string", - "description": "Error code. This is a mnemonic that can be consumed programmatically." - }, - "message": { - "type": "string", - "description": "User friendly error message. The message is typically localized and may vary with service version." - } - } + "$ref": "#/definitions/CloudErrorBody" + } + }, + "x-ms-external": true + }, + "CloudErrorBody": { + "description": "An error response from Key Vault resource provider", + "properties": { + "code": { + "type": "string", + "description": "Error code. This is a mnemonic that can be consumed programmatically." + }, + "message": { + "type": "string", + "description": "User friendly error message. The message is typically localized and may vary with service version." } }, "x-ms-external": true