core/io.github.stefankoppier.openapi.validator.core.rules.openapi.collections/RequestBodiesRule

RequestBodiesRule

class RequestBodiesRule(group: RuleGroup = RuleGroup.unknown()) : IterableRule<Pair<String, RequestBody>> (source)

Constructors

RequestBodiesRule

constructor(group: RuleGroup = RuleGroup.unknown())

Functions

all

fun all(description: String = "", rule: RequestBodyRule.() -> RequestBodyRule): RequestBodiesRule

each

fun <R : IterableRule<Pair<String, RequestBody>>> R.each(description: String = "", predicate: (Pair<String, RequestBody>) -> Boolean): R

Validate that all elements satisfy predicate.

either

fun <R : ValidationRule<Iterable<Pair<String, RequestBody>>>> R.either(vararg option: Iterable<Pair<String, RequestBody>>): R

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

exactly

fun <R : ValidationRule<Iterable<Pair<String, RequestBody>>>> R.exactly(value: Iterable<Pair<String, RequestBody>>): R

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

given

fun <R : ValidationRule<Iterable<Pair<String, RequestBody>>>> R.given(precondition: (Iterable<Pair<String, RequestBody>>?) -> Boolean, rule: R.() -> R): R

Validate rule only if precondition evaluates to true.

holds

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

Validate that predicate evaluates to true.

none

fun <R : IterableRule<Pair<String, RequestBody>>> R.none(description: String = "", predicate: (Pair<String, RequestBody>) -> Boolean): R

Validate that no element satisfies predicate.

not

fun <R : ValidationRule<Iterable<Pair<String, RequestBody>>>> R.not(message: String, rule: R.() -> R): R

Validate that the rule does not hold.

optional

fun <V, R : ValidationRule<Iterable<Pair<String, RequestBody>>>> R.optional(value: (Iterable<Pair<String, RequestBody>>?) -> V?, rule: R.() -> R): R

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

requestBody

fun requestBody(description: String = "", named: String, rule: RequestBodyRule.() -> RequestBodyRule): RequestBodiesRule

required

fun <R : ValidationRule<Iterable<Pair<String, RequestBody>>>> R.required(): R

Validate that the element is set.

since

fun <R : ValidationRule<Iterable<Pair<String, RequestBody>>>> R.since(date: LocalDate, rule: R.() -> R): R

Validate rule only if date has been in the past.

some

fun <R : IterableRule<Pair<String, RequestBody>>> R.some(description: String = "", predicate: (Pair<String, RequestBody>) -> Boolean): R

Validate that at least one element satisfies predicate.

unspecified

fun <R : ValidationRule<Iterable<Pair<String, RequestBody>>>> R.unspecified(): R

Validate that the element is not set.

validate

fun validate(fixture: Iterable<Pair<String, RequestBody>>?): ValidationResult

Execute the given rule(s) on the fixture.