Swagger::HeaderObject Class Reference

describes a single HTTP header More...

Inheritance diagram for Swagger::HeaderObject:

Public Member Functions
	constructor (hash< auto > oh, SwaggerSchema swagger)
	Constructor.
Public Member Functions inherited from Swagger::ObjectBase
	constructor ()
	Constructor.
	constructor (hash< auto > oh)
	Constructor.
	constructor (ObjectBase other)
	copy constructor
	initialize (hash< auto > oh)
	Initialize.
Public Member Functions inherited from Swagger::SchemaBase
	constructor (SchemaBase other)
	Copy constructor.
	constructor (string objType, hash< auto > oh)
	Constructor.

Public Attributes
*string	collectionFormat
	Determines the format of the array if type array is used.
auto	defaultVal
	Declares the value of the header that the server will use if none is provided.
*string	desc
	A short description of the header.
*string	format
	The extending format for the previously mentioned type. See Data Type Formats for further details.
*SchemaObject	items
	Required if type is "array". Describes the type of items in the array.
string	type
	Required. The type of the object.
Public Attributes inherited from Swagger::ObjectBase
hash< auto >	vendorExtensions
	Allows extensions to the Swagger Schema.
Public Attributes inherited from Swagger::SchemaBase
hash< string, bool >	enum
	See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1.
*bool	exclusiveMax
	See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2.
*bool	exclusiveMin
	See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3.
*softfloat	maximum
	See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2.
*int	maxItems
	See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2.
*int	maxLength
	See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1.
*softfloat	minimum
	See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3.
*int	minItems
	See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3.
*int	minLength
	See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2.
*float	multipleOf
	See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1.
*string	pattern
	See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3.
*bool	uniqueItems
	See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4.

Static Protected Member Functions
static	checkValueType (reference< auto > value, string type, *SchemaObject items, *string loc)
	validates default values
Static Protected Member Functions inherited from Swagger::SchemaBase
static	throwInvalidType (string name, string actual, string expected, auto value)
	throws an SCHEMA-VALIDATION-ERROR exception

Additional Inherited Members
Static Public Member Functions inherited from Swagger::SchemaBase
static bool	checkValueType (reference< auto > value, string type)
	Checks the value against the type.
Protected Member Functions inherited from Swagger::SchemaBase
	check (bool serialize, bool request, string type, *string format, *SchemaObject items, string path, string method, string name, reference< auto > value)
	validates the value against the schema definition
	checkArrayParam (bool serialize, bool request, SchemaObject items, string path, string method, string name, reference< list< auto > > value)
	validates the value against the schema definition
	checkIntern (bool serialize, bool request, string type, *string format, string path, string method, string name, binary v, reference value)
	converts binary values to strings for supported formats
	checkIntern (bool serialize, bool request, string type, *string format, string path, string method, string name, date v, reference< auto > value)
	converts dates to/from string or int values for supported formats
	checkIntern (bool serialize, bool request, string type, *string format, string path, string method, string name, string v, reference< auto > value)
	validates string values
	constructor ()
	Private constructor.
auto	getExampleValueWithFormat (string type, *string format, *string fname)
	returns an example value for the given type

Detailed Description

describes a single HTTP header

Member Function Documentation

constructor()

Swagger::HeaderObject::constructor	(	hash< auto >	oh,
		SwaggerSchema	swagger )

Constructor.

Parameters

oh	deserialized hash from the source schema description describing a single HTTP header
swagger	the REST schema for resolving references

Exceptions

INVALID-FIELD-TYPE	field has invalid type
INVALID-FIELD-VALUE	field has invalid value
REQUIRED-FIELD-MISSING	required field is missing

Member Data Documentation

collectionFormat

*string Swagger::HeaderObject::collectionFormat

Determines the format of the array if type array is used.

Possible values are:

• "csv": comma separated values; ex: foo,bar
• "ssv": space separated values; ex: foo bar
• "tsv": tab separated values; ex: foo\tbar
• "pipes": pipe separated values; ex: foo|bar

Default value is "csv".

defaultVal

auto Swagger::HeaderObject::defaultVal

Declares the value of the header that the server will use if none is provided.

(Note: "default" has no meaning for required headers.) See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2. Unlike JSON Schema this value MUST conform to the defined type for the header.

type

string Swagger::HeaderObject::type

Required. The type of the object.

The value MUST be one of "string", "number", "integer", "boolean", or "array".