ApiOperationResponseHeader

data class ApiOperationResponseHeader(val defaultValue: String? = null, val description: String? = null, val examples: List<ApiOperationResponseHeaderExample>? = null, val name: String, val required: Boolean, val schemaId: String? = null, val type: String, val typeName: String? = null, val values: List<String>? = null)

Constructors

Link copied to clipboard
constructor(defaultValue: String? = null, description: String? = null, examples: List<ApiOperationResponseHeaderExample>? = null, name: String, required: Boolean, schemaId: String? = null, type: String, typeName: String? = null, values: List<String>? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val defaultValue: String? = null

The default value for this Header.

Link copied to clipboard
val description: String? = null

A description of this Header.

Link copied to clipboard

One or more example blocks as defined above.

Link copied to clipboard

The Name of this Header.

Link copied to clipboard

Is this Header Required?

Link copied to clipboard
val schemaId: String? = null

The name of the Schema.

Link copied to clipboard

The Type of this Header, such as a string.

Link copied to clipboard
val typeName: String? = null

The type name defined by the Schema.

Link copied to clipboard
val values: List<String>? = null

One or more acceptable values for this Header.