View Source GoogleApi.ServiceConsumerManagement.V1.Model.DocumentationRule (google_api_service_consumer_management v0.32.0)

A documentation rule provides information about individual API elements.

Attributes

deprecationDescription (type: String.t, default: nil) - Deprecation description of the selected element(s). It can be provided if an element is marked as deprecated.
description (type: String.t, default: nil) - Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element.
disableReplacementWords (type: String.t, default: nil) - String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.
selector (type: String.t, default: nil) - The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. 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.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ServiceConsumerManagement.V1.Model.DocumentationRule{
  deprecationDescription: String.t() | nil,
  description: String.t() | nil,
  disableReplacementWords: String.t() | nil,
  selector: String.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.