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

OpenAPIRule

class OpenAPIRule : ValidationRule<OpenAPI> (source)

Functions

components

fun components(description: String = "", rule: ComponentsRule.() -> ComponentsRule): OpenAPIRule

either

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

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

exactly

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

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

externalDocs

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

given

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

Validate rule only if precondition evaluates to true.

holds

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

Validate that predicate evaluates to true.

info

fun info(description: String = "", rule: InfoRule.() -> InfoRule): OpenAPIRule

jsonSchemaDialect

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

not

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

Validate that the rule does not hold.

openapi

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

optional

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

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

paths

fun paths(description: String = "", rule: PathsRule.() -> PathsRule): OpenAPIRule

required

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

Validate that the element is set.

security

fun security(description: String = "", rule: SecurityRequirementsRule.() -> SecurityRequirementsRule): OpenAPIRule

servers

fun servers(description: String = "", rule: ServersRule.() -> ServersRule): OpenAPIRule

since

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

Validate rule only if date has been in the past.