core/io.github.stefankoppier.openapi.validator.core.rules.openapi/ServerVariableRule

ServerVariableRule

class ServerVariableRule : ValidationRule<ServerVariable> (source)

Functions

default

fun default(description: String = "", rule: StringRule.() -> StringRule): ServerVariableRule

description

fun description(description: String = "", rule: StringRule.() -> StringRule): ServerVariableRule

either

fun <R : ValidationRule<ServerVariable>> R.either(vararg option: ServerVariable): R

Validate that the element should be equal to one of the elements in option given that it is set.

enum

fun enum(description: String = "", rule: IterableStringRule.() -> IterableStringRule): ServerVariableRule

exactly

fun <R : ValidationRule<ServerVariable>> R.exactly(value: ServerVariable): R

Validate that the element should be equal to value given that it is set.

given

fun <R : ValidationRule<ServerVariable>> R.given(precondition: (ServerVariable?) -> Boolean, rule: R.() -> R): R

Validate rule only if precondition evaluates to true.

holds

fun <R : ValidationRule<ServerVariable>> R.holds(message: (ServerVariable?) -> String = { "Was supposed to hold for '$it' but did not" }, predicate: (ServerVariable?) -> Boolean): R

Validate that predicate evaluates to true.

not

fun <R : ValidationRule<ServerVariable>> R.not(message: String, rule: R.() -> R): R

Validate that the rule does not hold.

optional

fun <V, R : ValidationRule<ServerVariable>> R.optional(value: (ServerVariable?) -> V?, rule: R.() -> R): R

Validate rule only if the evaluated result of value is not null.

required

fun <R : ValidationRule<ServerVariable>> R.required(): R

Validate that the element is set.

since

fun <R : ValidationRule<ServerVariable>> R.since(date: LocalDate, rule: R.() -> R): R

Validate rule only if date has been in the past.

unspecified

fun <R : ValidationRule<ServerVariable>> R.unspecified(): R

Validate that the element is not set.

validate

fun validate(fixture: ServerVariable?): ValidationResult

Execute the given rule(s) on the fixture.