Skip to content

Commit 4f75d6a

Browse files
committed
AIP-193: Update the Help section
Significant changes here (all up for discussion): - Explicitly include Status.message as well as LocalizedMessage.message - Remove the standardized https://cloud.google.com/PRODUCT/docs/ERROR-REASON format requirement - Require the description to be suitable as text for a link - Require the description to be plain text - Require the URL to be absolute and include a scheme - Add authentication requirements
1 parent b119f8a commit 4f75d6a

1 file changed

Lines changed: 22 additions & 16 deletions

File tree

aip/general/0193.md

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -204,33 +204,39 @@ to the error. If more information is needed than can reasonably fit in this
204204
payload, then additional resolution information **must** be provided in
205205
a `Help` payload. See the [Help](#help) section for guidance.
206206

207-
#### Help payload
207+
#### Help
208208

209-
When `LocalizedMessage.message` doesn’t provide the user sufficient
209+
When other textual error messages (in `Status.message` or
210+
`LocalizedMessage.message`) don't provide the user sufficient
210211
context or actionable next steps, or if there are multiple points of
211212
failure that need to be considered in troubleshooting, a link to
212213
supplemental troubleshooting documentation **must** be provided in the
213214
`Help` payload.
214215

215216
Provide this information in addition to a clear problem definition and
216-
actionable resolution, not as an alternative to them; for example.
217+
actionable resolution, not as an alternative to them. The linked
218+
documentation **must** clearly relate to the error. If a single page
219+
contains information about multiple errors, the
220+
[`ErrorInfo.reason`](#errorinfo) value **must** be used to narrow down
221+
the relevant information.
217222

218-
**Note:** For more information, see the troubleshooting documentation:
219-
[https://cloud.google.com/compute/docs/resource-error][resource-error].
223+
The `description` field is a textual description of the linked information.
224+
This **must** be suitable to display to a user as text for a hyperlink.
225+
This **must** be plain text (not HTML, Markdown etc).
220226

221-
[Help payload][Help]
227+
Example `description` value: `"Troubleshooting documentation for STOCKOUT errors"`
222228

223-
Details of this object are summarized in the following fields, field
224-
descriptions, and examples:
229+
The `url` field is the URL to link to. This **must** be an absolute URL,
230+
including scheme.
225231

226-
- `description string`
227-
- Describes what the link offers.
228-
- *Example*: "Troubleshooting documentation for STOCKOUT errors"
229-
- `url string`
230-
- The URL of the link. For error documentation this must follow the
231-
standardized format listed in the following example.
232-
- *Example*:
233-
https://cloud.google.com/PRODUCT/docs/ERROR-REASON
232+
Example `url` value:
233+
`"https://cloud.google.com/compute/docs/resource-error"`
234+
235+
For publicly-documented services, even those with access controls on actual
236+
usage, the linked content **must** be accessible without authentication.
237+
238+
For privately-documented services, the linked content **may** require
239+
authentication.
234240

235241
### Error messages
236242

0 commit comments

Comments
 (0)