Class DocumentationRule

A documentation rule provides information about individual API elements.

Inheritance
object
DocumentationRule
Implements
Inherited Members
Namespace: Google.Apis.ServiceUsage.v1.Data
Assembly: Google.Apis.ServiceUsage.v1.dll
Syntax
public class DocumentationRule : IDirectResponseSchema

Properties

DeprecationDescription

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

Declaration
[JsonProperty("deprecationDescription")]
public virtual string DeprecationDescription { get; set; }
Property Value
Type Description
string

Description

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.

Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type Description
string

DisableReplacementWords

String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.

Declaration
[JsonProperty("disableReplacementWords")]
public virtual string DisableReplacementWords { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Selector

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.

Declaration
[JsonProperty("selector")]
public virtual string Selector { get; set; }
Property Value
Type Description
string

Implements