Update 0193.md #1251
Open
Update 0193.md #1251
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
As part of the actionable errors initiative, I have modified the error message to be more descriptive and included a link to documentation. This is based on our recommended guidelines in the design process: https://docs.google.com/document/d/19z0AMtEqsG_d44sEVgNST0JN7NBWBHWjBAmWVA8yR38/edit#bookmark=id.rsxve02tqdl4 I have also changed the error reason to resource availability according to this guide: https://cloud.google.com/compute/docs/troubleshooting/troubleshooting-resource-availability#resolve_resource_errors These changes have been approved by Bryan Z. and Julie S., PM and IX lead of actionable errors. Please update the example on the AIP-193 website accordingly.
|
I understand there were some formatting issues, sorry about that. |
aip/general/0193.md
Outdated
| @@ -47,19 +47,31 @@ following: | |||
| "details": [ | |||
| { | |||
| "@type": "type.googleapis.com/google.rpc.ErrorInfo", | |||
| "reason": "STOCKOUT", | |||
| "reason": "resource_availability", | |||
There was a problem hiding this comment.
should this be in all-caps?
There was a problem hiding this comment.
good point. I think it should be yes.
aip/general/0193.md
Outdated
| } | ||
| }, | ||
| { | ||
| "@type": "type.googleapis.com/google.rpc.LocalizedMessage", | ||
| "locale": "en-US", | ||
| "message": "A e2-medium with local-ssd=3,nvidia-t4=2 is currently unavailable in the us-east1-a zone.\nCapacity changes frequently, so try your request in a different zone, with a different VM hardware configuration, or at a later time. For more information, see troubleshooting documentation." | ||
| "message": An <e2-medium> VM instance with <local-ssd=3,nvidia-t4=2> is currently unavailable in the <us-east1-a> zone.\n |
There was a problem hiding this comment.
this field cannot contain line breaks, as it breaks json formatting. Please keep the content on a single line and use just escaped line breaks, '\n', instead.
I fixed the formatting issues. let me know if there is anything else
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As part of the actionable errors initiative, I have modified the error message to be more descriptive and included a link to documentation. This is based on our recommended guidelines in the design process: https://docs.google.com/document/d/19z0AMtEqsG_d44sEVgNST0JN7NBWBHWjBAmWVA8yR38/edit#bookmark=id.rsxve02tqdl4
I have also changed the error reason to resource availability according to this guide: https://cloud.google.com/compute/docs/troubleshooting/troubleshooting-resource-availability#resolve_resource_errors
These changes have been approved by Bryan Z. and Julie S., PM and IX lead of actionable errors. Please update the example on the AIP-193 website accordingly.