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

EncodingRule

class EncodingRule(group: RuleGroup = RuleGroup.unknown()) : ValidationRule<Encoding> (source)

Constructors

EncodingRule

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

Functions

allowReserved

fun allowReserved(description: String = "", rule: BooleanRule.() -> BooleanRule): EncodingRule

contentType

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

either

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

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

exactly

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

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

explode

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

given

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

Validate rule only if precondition evaluates to true.

headers

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

holds

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

Validate that predicate evaluates to true.

not

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

Validate that the rule does not hold.

optional

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

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

required

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

Validate that the element is set.

since

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

unspecified

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

Validate that the element is not set.

validate

fun validate(fixture: Encoding?): ValidationResult

Execute the given rule(s) on the fixture.