Attributes

• $ref (String.t): A reference to another schema. The value of this property is the "id" of another schema. Defaults to: null.
• additionalProperties (JsonSchema): If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object. Defaults to: null.
• annotations (JsonSchemaAnnotations): Defaults to: null.
• default (String.t): The default value of this property (if one exists). Defaults to: null.
• description (String.t): A description of this object. Defaults to: null.
• enum ([String.t]): Values this parameter may take (if it is an enum). Defaults to: null.
• enumDescriptions ([String.t]): The descriptions for the enums. Each position maps to the corresponding value in the "enum" array. Defaults to: null.
• format (String.t): 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 Defaults to: null.
• id (String.t): Unique identifier for this schema. Defaults to: null.
• items (JsonSchema): If this is a schema for an array, this property is the schema for each element in the array. Defaults to: null.
• location (String.t): Whether this parameter goes in the query or the path for REST requests. Defaults to: null.
• maximum (String.t): The maximum value of this parameter. Defaults to: null.
• minimum (String.t): The minimum value of this parameter. Defaults to: null.
• pattern (String.t): 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 Defaults to: null.
• properties (%{optional(String.t) => JsonSchema}): If this is a schema for an object, list the schema for each property of this object. Defaults to: null.
• readOnly (boolean()): 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. Defaults to: null.
• repeated (boolean()): Whether this parameter may appear multiple times. Defaults to: null.
• required (boolean()): Whether the parameter is required. Defaults to: null.
• type (String.t): 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 Defaults to: null.
• variant (JsonSchemaVariant): Defaults to: null.