Skip to content

[Hub Generated] Review request for Microsoft.KeyVault to add version stable/2019-09-01 #12475

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 5, 2021
Merged

[Hub Generated] Review request for Microsoft.KeyVault to add version stable/2019-09-01 #12475

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c44cc78
Add missing default error responses
jiacheng-L Jan 18, 2021
0ecad92
fix copy/paste error
jiacheng-L Jan 18, 2021
e28e135
unify the error model
jiacheng-L Jan 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2019-09-01/keyvault.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -443,6 +443,12 @@
"schema": {
"$ref": "#/definitions/VaultListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-pageable": {
Expand Down Expand Up @@ -489,6 +495,12 @@
"schema": {
"$ref": "#/definitions/VaultListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-pageable": {
Expand Down Expand Up @@ -528,6 +540,12 @@
"schema": {
"$ref": "#/definitions/DeletedVaultListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-pageable": {
Expand Down Expand Up @@ -719,6 +737,12 @@
"schema": {
"$ref": "#/definitions/ResourceListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-pageable": {
Expand Down Expand Up @@ -764,6 +788,12 @@
"schema": {
"$ref": "#/definitions/CheckNameAvailabilityResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-examples": {
Expand Down
29 changes: 29 additions & 0 deletions specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2019-09-01/providers.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,12 @@
"schema": {
"$ref": "#/definitions/OperationListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ProviderError"
}
}
},
"x-ms-pageable": {
Expand Down Expand Up @@ -152,6 +158,29 @@
"description": "Blob duration of specification."
}
}
},
"ProviderError": {
"description": "An error response from Key Vault resource provider",
"properties": {
"error": {
Copy link
Member

@heaths heaths Jan 27, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is the actual error nested? Is this common of mgmt plane?

Copy link
Contributor Author

@jiacheng-L jiacheng-L Jan 27, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believed so. Both Key.json and KeyVault.json use the same model.

"$ref": "#/definitions/ProviderErrorBody"
}
},
"x-ms-external": true
},
"ProviderErrorBody": {
Copy link
Member

@heaths heaths Jan 27, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the same as CloudError. Does a new model need to be created? Or is the thought they could diverge at some point?

Copy link
Contributor Author

@jiacheng-L jiacheng-L Jan 27, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@heaths They are the same. I updated it to CloudError, as well as the one in secrets.json, which I defined in the last PR

"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": {
Expand Down