Skip to content

Commit fbf2a22

Browse files
jschneider11shwoodardandrei-scripniciuc
authored
Update AIP-193 with actionable errors guidance. (#1305)
* Update 0193.md Incorporating writing guidance for messages into AIP-193. * Updated tables to Markdown. * Correcting Markdown on the first table only. * Removing pluses in first table for testing. * Updated JSON. Changed first table to bulleted list. * Fixed JSON, removed text referencing rtables. changed all tables to bulleted lists. * Committing changes again: Fixed JSON, text referring to tables, moved tables to bulleted lists. * Committing pre-formatted content from Andrei * Fixed indentation problem starting at line 207. * Update 0193.md Adding writing guidance and converting HTML to Markdown. * Fix whitespace, especially line width. * Restrict line width to 80 characters, applying standards for md format, e.g wrapping for links, etc. * Add whitespace after head matter. * Format bullets using dashes instead of astrices, to match style of the other AIPs. * Reestablish and add named anchors. * Fix broken links and expand warning * Update 0193.md Removed anchor for error-reason and accepting Sam's updates to bullets. * Update 0193.md Fixed bullets from 3-level to 2-level. * Remove unused named anchor * Updated bullets to Markdown Updated bullets to Markdown * Update 0193.md Made the following updates: - Fixed Text field for details.Object (repeated) - Updated "Structure details with machine-readable identifiers." - Removed the entire "Message Layout" section, as Andrei will update the SDK AIP instead. - All Status.message fields were already downcased. - * Whitespace and minor edits * Fix all whitespace--vertical and horizontal * Line length * Remove unneeeded vertical spacing between headers and paragraphs * Edits * Change error messages from code treatment to quoted text * Minor rephrasing here and there * Fix all regex and more whitespace fixes. * Update 0193.md - Changed "human developers" to "developers." - Removed capitalization for "That." - Added spaces between words that appear next to each other. - Updated guidance on how to extract dynamic information. * Update 0193.md - Simplified last line of introduction in ErrorDetails. - Fixed regex in metadata map section. Note: If there's any way to outdent domain string and metadata map in the bulleted list, it would make the text read better. * Fix whitespace * Resolved hidden comments in the PR - Removed confusing verbiage about LocalizedMessage being the same as Status.message or different. - Removed section stating reasons to present the same error message in both locations. * Another whitespace fix * Moved reasons to present differing or non-differing messages to the Rationale section Moved reasons to present the same error message in Status.message and Localized.message vs. differing messages to the Rationale section. * Fixing line formatting. Fixing line formatting on lines 392 and 475. * Closed 3 comments, changed state to Draft - Changed the state of the AIP to Draft as suggested by Andrei. - Updated all references to HelpLink to Help. - Removed line 192, which duplicated line 195+ - Removed "By default" line 389 as it is not enforced by anything. - * Reversed line about uniqueness. Fixed typos. - Fixed formatting issue on line 337 - Fixed typo on line 347 - Added back in: "Be unique and consumable by machine actors for automation." Removed: Map to one and only one cause." * Replace example error code for status example The example message is actually RESOURCE_EXHAUSTED, code 8, HTTP status code information. * Fixed error code in JSON example Fixed error code in JSON example to reflect the RESOURCE_EXCEEDED code of 8. --------- Co-authored-by: Sam Woodard <sam.h.woodard@gmail.com> Co-authored-by: Andrei Scripniciuc <46186670+andrei-scripniciuc@users.noreply.github.com> Co-authored-by: Sam Woodard <samwoodard@google.com>
1 parent 4f222e9 commit fbf2a22

1 file changed

Lines changed: 390 additions & 155 deletions

File tree

0 commit comments

Comments
 (0)