Class: Google::Api::DocumentationRule

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/api/documentation.rb

Overview

A documentation rule provides information about individual API elements.

Instance Attribute Summary collapse

Instance Attribute Details

#deprecation_description ⇒ ::String

Returns Deprecation description of the selected element(s). It can be provided if an element is marked as deprecated.

Returns:

  • (::String) —

    Deprecation description of the selected element(s). It can be provided if an element is marked as deprecated.



139
140
141
142
 
# File 'proto_docs/google/api/documentation.rb', line 139

class DocumentationRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#description ⇒ ::String

Returns 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.

Returns:

  • (::String) —

    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.



139
140
141
142
 
# File 'proto_docs/google/api/documentation.rb', line 139

class DocumentationRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#selector ⇒ ::String

Returns 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.

Returns:

  • (::String) —

    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.



139
140
141
142
 
# File 'proto_docs/google/api/documentation.rb', line 139

class DocumentationRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end