ApiRequestParameter

data class ApiRequestParameter(val defaultValue: String? = null, val description: String? = null, val in: String, val inService: String, val name: String, val nameService: String, val required: String, val type: String)

Constructors

Link copied to clipboard
fun ApiRequestParameter(defaultValue: String? = null, description: String? = null, in: String, inService: String, name: String, nameService: String, required: String, type: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val defaultValue: String? = null

The default value of the parameter.

Link copied to clipboard
val description: String? = null

The description of the api. Defaults to null.

Link copied to clipboard
val in: String

Request's parameter location; values: BODY, HEAD, QUERY, and PATH.

Link copied to clipboard

Backend service's parameter location; values: BODY, HEAD, QUERY, and PATH.

Link copied to clipboard

The name of the api gateway api. Defaults to null.

Link copied to clipboard

Backend service's parameter name.

Link copied to clipboard

Parameter required or not; values: REQUIRED and OPTIONAL.

Link copied to clipboard

Parameter type which supports values of 'STRING','INT','BOOLEAN','LONG',"FLOAT" and "DOUBLE".