Azure-docs: KeyVault Error responses page should reflect the actual API REST responses

Created on 26 Mar 2020  Â·  4Comments  Â·  Source: MicrosoftDocs/azure-docs

This page currently isn't very useful when writing error handling code that interacts with the API.

The common structure of errors that come back from the actual service seems to be { "error": { "code": "Unauthorized" | ???, "message": "Human readable message about problem" } }. More documentation about the possible error codes and possible other error structures (seems like sometimes something like { "error": "invalid_client", "error_description": "CODE: desc" } comes back) would be greatly appreciated.

Right now I'm just manually poking the API to try to write reasonable parsers for the different possible error codes. Something like https://docs.microsoft.com/en-us/rest/api/storageservices/common-rest-api-error-codes would be great.


Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Pri2 assigned-to-author doc-enhancement key-vaulsvc triaged

All 4 comments

@skeet70 Thanks for the feedback ! I have assigned this issue to content author to investigate and update the document as appropriate.

We are working on documenting.

Added a new document to capture Key vault rest API error codes, will continue adding more here
https://docs.microsoft.com/en-us/azure/key-vault/general/common-error-codes

please-close

Was this page helpful?
0 / 5 - 0 ratings

Related issues

Ponant picture Ponant  Â·  3Comments

bdcoder2 picture bdcoder2  Â·  3Comments

jamesgallagher-ie picture jamesgallagher-ie  Â·  3Comments

spottedmahn picture spottedmahn  Â·  3Comments

ianpowell2017 picture ianpowell2017  Â·  3Comments