The Swagger Header object

The Header object defines header characteristics.

Required properties

Property Type Description Combination style
items Items object Required if type is array. Do not use otherwise. First non-null
type string

Required. Documentation only. PolicyCenter returns header values on responses as they are and does not validate the header values.

Valid values are:
  • array
  • boolean
  • integer
  • number
  • string
 First non-null

Optional properties

Property Type Description Combination style
collectionFormat string

Documentation only. PolicyCenter returns header values on responses as they are and does not validate the header values.

The value must be one of the following:
  • csv
  • ssv
  • tsv
  • pipes
 First non-null
default Any object type

Documentation only. PolicyCenter returns header values on responses as they are and does not validate the header values.

Value needs to be a valid according to the combination of type, format, and x-gw-type.

 First non-null
description string Documentation only. First non-null
enum anyType[]

Documentation only. PolicyCenter returns header values on responses as they are and does not validate the header values.

Value needs to be a valid according to the combination of type, format, and x-gw-type.

 First non-null
exclusiveMaximum boolean

Documentation only. PolicyCenter returns header values on responses as they are and does not validate the header values.

 First non-null
exclusiveMinimum boolean

Documentation only. PolicyCenter returns header values on responses as they are and does not validate the header values.

 First non-null
format string Documentation only. PolicyCenter returns header values on responses as they are and does not validate the header values. First non-null
maximum number

Documentation only. PolicyCenter returns header values on responses as they are and does not validate the header values.

 First non-null
maxItems integer

Documentation only. PolicyCenter returns header values on responses as they are and does not validate the header values.

 First non-null
maxlength integer

Documentation only. PolicyCenter returns header values on responses as they are and does not validate the header values.

 First non-null
minimum number

Documentation only. PolicyCenter returns header values on responses as they are and does not validate the header values.

 First non-null
minItems integer

Documentation only. PolicyCenter returns header values on responses as they are and does not validate the header values.

 First non-null
minLength integer

Documentation only. PolicyCenter returns header values on responses as they are and does not validate the header values.

 First non-null
multipleOf number

Documentation only. PolicyCenter returns header values on responses as they are and does not validate the header values.

 First non-null
pattern string

Documentation only. PolicyCenter returns header values on responses as they are and does not validate the header values.

 First non-null
uniqueItems boolean

Documentation only. PolicyCenter returns header values on responses as they are and does not validate the header values.

 First non-null

Guidewire extension properties

Property Type Description Combination style
x-gw-export-enumeration boolean

If set to true, PolicyCenter writes out the typekey values as an enum property while creating the Swagger schema for external clients. A value of true is only valid if the enum property is not set and x-gw-type is a typekey type.

The default is false.

 First non-null
x-gw-type string Documentation only. PolicyCenter returns header values on responses as they are and does not validate the header values. First non-null