Show / Hide Table of Contents

Class JsonSchema

Inheritance
object
JsonSchema
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Discovery.v1.Data
Assembly: Google.Apis.Discovery.v1.dll
Syntax
public class JsonSchema : IDirectResponseSchema

Properties

AdditionalProperties

If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object.

Declaration
[JsonProperty("additionalProperties")]
public virtual JsonSchema AdditionalProperties { get; set; }
Property Value
Type Description
JsonSchema

Annotations

Additional information about this property.

Declaration
[JsonProperty("annotations")]
public virtual JsonSchema.AnnotationsData Annotations { get; set; }
Property Value
Type Description
JsonSchema.AnnotationsData

Default__

The default value of this property (if one exists).

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

Deprecated

Whether the parameter is deprecated.

Declaration
[JsonProperty("deprecated")]
public virtual bool? Deprecated { get; set; }
Property Value
Type Description
bool?

Description

A description of this object.

Declaration
[JsonProperty("description")]
public virtual string Description { 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

EnumDeprecated

The deprecation status for the enums. Each position maps to the corresponding value in the "enum" array.

Declaration
[JsonProperty("enumDeprecated")]
public virtual IList<bool?> EnumDeprecated { get; set; }
Property Value
Type Description
IList<bool?>

EnumDescriptions

The descriptions for the enums. Each position maps to the corresponding value in the "enum" array.

Declaration
[JsonProperty("enumDescriptions")]
public virtual IList<string> EnumDescriptions { get; set; }
Property Value
Type Description
IList<string>

Enum__

Values this parameter may take (if it is an enum).

Declaration
[JsonProperty("enum")]
public virtual IList<string> Enum__ { get; set; }
Property Value
Type Description
IList<string>

Format

An additional regular expression or key that helps constrain the value. For more details see: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23

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

Id

Unique identifier for this schema.

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

Items

If this is a schema for an array, this property is the schema for each element in the array.

Declaration
[JsonProperty("items")]
public virtual JsonSchema Items { get; set; }
Property Value
Type Description
JsonSchema

Location

Whether this parameter goes in the query or the path for REST requests.

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

Maximum

The maximum value of this parameter.

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

Minimum

The minimum value of this parameter.

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

Pattern

The regular expression this parameter must conform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html

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

Properties

If this is a schema for an object, list the schema for each property of this object.

Declaration
[JsonProperty("properties")]
public virtual IDictionary<string, JsonSchema> Properties { get; set; }
Property Value
Type Description
IDictionary<string, JsonSchema>

ReadOnly__

The value is read-only, generated by the service. The value cannot be modified by the client. If the value is included in a POST, PUT, or PATCH request, it is ignored by the service.

Declaration
[JsonProperty("readOnly")]
public virtual bool? ReadOnly__ { get; set; }
Property Value
Type Description
bool?

Ref__

A reference to another schema. The value of this property is the "id" of another schema.

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

Repeated

Whether this parameter may appear multiple times.

Declaration
[JsonProperty("repeated")]
public virtual bool? Repeated { get; set; }
Property Value
Type Description
bool?

Required

Whether the parameter is required.

Declaration
[JsonProperty("required")]
public virtual bool? Required { get; set; }
Property Value
Type Description
bool?

Type

The value type for this schema. A list of values can be found here: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1

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

Variant

In a variant data type, the value of one property is used to determine how to interpret the entire entity. Its value must exist in a map of descriminant values to schema names.

Declaration
[JsonProperty("variant")]
public virtual JsonSchema.VariantData Variant { get; set; }
Property Value
Type Description
JsonSchema.VariantData

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX