Class DocumentationRule

A documentation rule provides information about individual API elements.

Inheritance

System.Object

DocumentationRule

Implements

IDirectResponseSchema

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

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
System.String

Description

Description of the selected API(s).

Declaration

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

Property Value

Type	Description
System.String

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
System.String

Selector

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.

Declaration

[JsonProperty("selector")]
public virtual string Selector { get; set; }

Property Value

Type	Description
System.String

Implements

IDirectResponseSchema