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

SchemaRule

class SchemaRule : ValidationRule<Schema<*>> (source)

Functions

allOf

fun allOf(description: String = "", rule: SchemasRule.() -> SchemasRule): SchemaRule

anyOf

fun anyOf(description: String = "", rule: SchemasRule.() -> SchemasRule): SchemaRule

deprecated

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

description

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

discriminator

fun discriminator(description: String = "", rule: DiscriminatorRule.() -> DiscriminatorRule): SchemaRule

either

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

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

exactly

fun <R : ValidationRule<Schema<*>>> R.exactly(value: Schema<*>): R

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

exclusiveMaximum

fun exclusiveMaximum(description: String = "", rule: BooleanRule.() -> BooleanRule): SchemaRule

exclusiveMinimum

fun exclusiveMinimum(description: String = "", rule: BooleanRule.() -> BooleanRule): SchemaRule

externalDocs

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

format

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

given

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

Validate rule only if precondition evaluates to true.

holds

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

Validate that predicate evaluates to true.

items

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

maximum

fun maximum(description: String = "", rule: BigDecimalRule.() -> BigDecimalRule): SchemaRule

maxItems

fun maxItems(description: String = "", rule: IntegerRule.() -> IntegerRule): SchemaRule

maxLength

fun maxLength(description: String = "", rule: IntegerRule.() -> IntegerRule): SchemaRule

maxProperties

fun maxProperties(description: String = "", rule: IntegerRule.() -> IntegerRule): SchemaRule

minimum

fun minimum(description: String = "", rule: BigDecimalRule.() -> BigDecimalRule): SchemaRule

minItems

fun minItems(description: String = "", rule: IntegerRule.() -> IntegerRule): SchemaRule

minLength

fun minLength(description: String = "", rule: IntegerRule.() -> IntegerRule): SchemaRule

minProperties

fun minProperties(description: String = "", rule: IntegerRule.() -> IntegerRule): SchemaRule

multipleOf

fun multipleOf(description: String = "", rule: BigDecimalRule.() -> BigDecimalRule): SchemaRule

name

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

not

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

not

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

Validate that the rule does not hold.

nullable

fun nullable(description: String = "", rule: BooleanRule.() -> BooleanRule): SchemaRule

oneOf

fun oneOf(description: String = "", rule: SchemasRule.() -> SchemasRule): SchemaRule

optional

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

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

pattern

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

properties

fun properties(description: String = "", rule: SchemasRule.() -> SchemasRule): SchemaRule

readOnly

fun readOnly(description: String = "", rule: BooleanRule.() -> BooleanRule): SchemaRule

ref

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

required

fun required(description: String = "", rule: IterableStringRule.() -> IterableStringRule): SchemaRule

required

fun <R : ValidationRule<Schema<*>>> R.required(): R

Validate that the element is set.

since

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

Validate rule only if date has been in the past.

title

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

type

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

uniqueItems

fun uniqueItems(description: String = "", rule: BooleanRule.() -> BooleanRule): SchemaRule

unspecified

fun <R : ValidationRule<Schema<*>>> R.unspecified(): R

Validate that the element is not set.

validate

fun validate(fixture: Schema<*>?): ValidationResult

Execute the given rule(s) on the fixture.

writeOnly

fun writeOnly(description: String = "", rule: BooleanRule.() -> BooleanRule): SchemaRule

xml

fun xml(description: String = "", rule: XMLRule.() -> XMLRule): SchemaRule