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

OperationRule

class OperationRule : ValidationRule<Operation> (source)

Functions

callbacks

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

deprecated

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

description

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

either

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

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

exactly

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

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

externalDocs

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

given

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

Validate rule only if precondition evaluates to true.

holds

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

Validate that predicate evaluates to true.

not

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

Validate that the rule does not hold.

operationId

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

optional

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

requestBody

fun requestBody(description: String = "", rule: RequestBodyRule.() -> RequestBodyRule): OperationRule

required

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

Validate that the element is set.

responses

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

security

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

servers

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

since

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

Validate rule only if date has been in the past.

summary

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