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

ExternalDocumentationRule

class ExternalDocumentationRule : ValidationRule<ExternalDocumentation> (source)

Functions

description

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

either

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

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

exactly

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

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

given

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

Validate rule only if precondition evaluates to true.

holds

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

Validate that predicate evaluates to true.

not

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

Validate that the rule does not hold.

optional

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

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

required

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

Validate that the element is set.

since

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

Validate rule only if date has been in the past.

unspecified

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

Validate that the element is not set.

url

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

validate

fun validate(fixture: ExternalDocumentation?): ValidationResult

Execute the given rule(s) on the fixture.