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

PathRule

class PathRule : ValidationRule<Pair<String, PathItem>> (source)

Functions

delete

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

description

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

either

fun <R : ValidationRule<Pair<String, PathItem>>> R.either(vararg option: Pair<String, PathItem>): R

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

exactly

fun <R : ValidationRule<Pair<String, PathItem>>> R.exactly(value: Pair<String, PathItem>): R

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

get

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

given

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

Validate rule only if precondition evaluates to true.

head

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

holds

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

Validate that predicate evaluates to true.

not

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

Validate that the rule does not hold.

operations

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

optional

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

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

options

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

parameters

fun parameters(description: String = "", rule: ParametersRule.() -> ParametersRule): PathRule

patch

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

path

fun path(rule: OperationPathRule.() -> OperationPathRule): PathRule

post

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

put

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

required

fun <R : ValidationRule<Pair<String, PathItem>>> R.required(): R

Validate that the element is set.

servers

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

since

fun <R : ValidationRule<Pair<String, PathItem>>> 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): PathRule

trace

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

unspecified

fun <R : ValidationRule<Pair<String, PathItem>>> R.unspecified(): R

Validate that the element is not set.

validate

fun validate(fixture: Pair<String, PathItem>?): ValidationResult

Execute the given rule(s) on the fixture.