manifest/me.ahoo.wow.manifest/RouteParameterManifest

RouteParameterManifest

class RouteParameterManifest @InternalWowApi constructor(val name: String, val location: RouteParameterManifest.Location, val schema: Map<String, Any?>, val required: Boolean = location == Location.PATH)

A parameter of a ServiceRouteManifest: a variable of its path or a query parameter (location), its schema an inline JSON Schema of a scalar ({"type":"string"}, an enum), and whether a call must give it (required; a path variable always is).

Fields may be added: pass the constructor's arguments by name.

Constructors

@InternalWowApi

constructor(name: String, location: RouteParameterManifest.Location, schema: Map<String, Any?>, required: Boolean = location == Location.PATH)

Types

Location

enum class Location : Enum<RouteParameterManifest.Location>

Where a parameter is read from.

Properties

location

val location: RouteParameterManifest.Location

name

val name: String

required

val required: Boolean

schema

val schema: Map<String, Any?>

Functions

copyWith

@InternalWowApi

fun RouteParameterManifest.copyWith(name: String = this.name, location: RouteParameterManifest.Location = this.location, schema: Map<String, Any?> = this.schema, required: Boolean = this.required): RouteParameterManifest

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String