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

ContactRule

class ContactRule : ValidationRule<Contact> (source)

Functions

either

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

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

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

exactly

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

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

given

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

Validate rule only if precondition evaluates to true.

holds

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

Validate that predicate evaluates to true.

name

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

not

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

Validate that the rule does not hold.

optional

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

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

required

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

Validate that the element is set.

since

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

Validate rule only if date has been in the past.

unspecified

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

Validate that the element is not set.

url

fun url(description: String = "", rule: URLRule.() -> URLRule): ContactRule

validate

fun validate(fixture: Contact?): ValidationResult

Execute the given rule(s) on the fixture.