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

ComponentsRule

class ComponentsRule : ValidationRule<Components> (source)

Functions

callbacks

fun callbacks(description: String = "", rule: CallbacksRule.() -> CallbacksRule): ComponentsRule

either

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

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

exactly

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

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

examples

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

given

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

Validate rule only if precondition evaluates to true.

headers

fun headers(description: String = "", rule: HeadersRule.() -> HeadersRule): ComponentsRule

holds

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

Validate that predicate evaluates to true.

links

fun links(description: String = "", rule: LinksRule.() -> LinksRule): ComponentsRule

not

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

Validate that the rule does not hold.

optional

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

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

parameters

fun parameters(description: String = "", rule: ParametersRule.() -> ParametersRule): ComponentsRule

requestBodies

fun requestBodies(description: String = "", rule: RequestBodiesRule.() -> RequestBodiesRule): ComponentsRule

required

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

Validate that the element is set.

responses

fun responses(description: String = "", rule: ResponsesRule.() -> ResponsesRule): ComponentsRule

schemas

fun schemas(description: String = "", rule: SchemasRule.() -> SchemasRule): ComponentsRule

since

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

Validate rule only if date has been in the past.

unspecified

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

Validate that the element is not set.

validate

fun validate(fixture: Components?): ValidationResult

Execute the given rule(s) on the fixture.