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

HeaderRule

class HeaderRule(group: RuleGroup = RuleGroup.unknown()) : ValidationRule<Header> (source)

Constructors

HeaderRule

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

Functions

content

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

deprecated

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

description

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

either

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

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

exactly

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

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

example

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

examples

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

explode

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

given

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

Validate rule only if precondition evaluates to true.

holds

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

Validate that predicate evaluates to true.

not

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

Validate that the rule does not hold.

optional

fun <V, R : ValidationRule<Header>> R.optional(value: (Header?) -> 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): HeaderRule

required

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

Validate that the element is set.

schema

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

since

fun <R : ValidationRule<Header>> 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<Header.StyleEnum>.() -> EnumRule<Header.StyleEnum>): HeaderRule

unspecified

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

Validate that the element is not set.

validate

fun validate(fixture: Header?): ValidationResult

Execute the given rule(s) on the fixture.