Share feedback
Answers are generated based on the documentation.

Experimental

Product manualDownload OpenAPI specificationMarkdown

Schema

HelpErrorDetail

Type: object

Provides links to documentation or for performing an out of band action.

For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.

@type · required

Type: string

All schema constraints and annotations
{
  "const": "type.googleapis.com/google.rpc.Help",
  "type": "string"
}
links

Type: array

URL(s) pointing to additional information on handling the current error.
Array item

Schema: HelpLink

All schema constraints and annotations
{
  "description": "URL(s) pointing to additional information on handling the current error.",
  "items": {
    "$ref": "#/components/schemas/HelpLink"
  },
  "type": "array"
}
All schema constraints and annotations
{
  "description": "Provides links to documentation or for performing an out of band action.\n\nFor example, if a quota check failed with an error indicating the calling\nproject hasn't enabled the accessed service, this can contain a URL pointing\ndirectly to the right place in the developer console to flip the bit.",
  "properties": {
    "@type": {
      "const": "type.googleapis.com/google.rpc.Help",
      "type": "string"
    },
    "links": {
      "description": "URL(s) pointing to additional information on handling the current error.",
      "items": {
        "$ref": "#/components/schemas/HelpLink"
      },
      "type": "array"
    }
  },
  "required": [
    "@type"
  ],
  "title": "HelpErrorDetail",
  "type": "object"
}