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

ParameterRule

class ParameterRule : ValidationRule<Parameter> (source)

Functions

allowEmptyValue

fun allowEmptyValue(description: String = "", rule: BooleanRule.() -> BooleanRule): ParameterRule

allowReserved

fun allowReserved(description: String = "", rule: BooleanRule.() -> BooleanRule): ParameterRule

content

fun content(description: String = "", rule: ContentRule.() -> ContentRule): ParameterRule

deprecated

fun deprecated(description: String = "", rule: BooleanRule.() -> BooleanRule): ParameterRule

description

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

either

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

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

exactly

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

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

example

fun example(description: String = "", rule: AnyRule.() -> AnyRule): ParameterRule

examples

fun examples(description: String = "", rule: ExamplesRule.() -> ExamplesRule): ParameterRule

explode

fun explode(description: String = "", rule: BooleanRule.() -> BooleanRule): ParameterRule

given

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

Validate rule only if precondition evaluates to true.

holds

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

Validate that predicate evaluates to true.

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

name

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

not

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

Validate that the rule does not hold.

optional

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

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

required

fun required(description: String = "", rule: BooleanRule.() -> BooleanRule): ParameterRule

required

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

Validate that the element is set.

schema

fun schema(description: String = "", rule: SchemaRule.() -> SchemaRule): ParameterRule

since

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

Validate rule only if date has been in the past.

style

fun style(description: String = "", rule: EnumRule<Parameter.StyleEnum>.() -> EnumRule<Parameter.StyleEnum>): ParameterRule

unspecified

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

Validate that the element is not set.

validate

fun validate(fixture: Parameter?): ValidationResult

Execute the given rule(s) on the fixture.