google_api_service_user v0.5.0 GoogleApi.ServiceUser.V1.Model.DocumentationRule View Source

A documentation rule provides information about individual API elements.

Attributes

  • deprecationDescription (String.t): Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`. Defaults to: null.
  • description (String.t): Description of the selected API(s). Defaults to: null.
  • selector (String.t): The selector is a comma-separated list of patterns. Each pattern is a qualified name of the element which may end in "", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo." is ok, but not "foo.b" or "foo..bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used. Defaults to: null.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t() View Source
t() :: %GoogleApi.ServiceUser.V1.Model.DocumentationRule{
  deprecationDescription: any(),
  description: any(),
  selector: any()
}

Link to this section Functions

Link to this function

decode(value, options) View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.