ai-mocks-core/dev.mokksy.aimocks.core/ModelRequestSpecification

ModelRequestSpecification

abstract class ModelRequestSpecification(var model: String? = null, val requestBody: MutableList<Matcher<P?>> = mutableListOf(), val requestBodyString: MutableList<Matcher<String?>> = mutableListOf())(source)

Represents a specification model for processing and asserting certain conditions on a request body.

This abstract class allows configuring conditions for matching and validating the attributes or structure of the request body, either as a whole object or in its string representation. Suitable for cases where flexible request validation is needed.

Type Parameters

The type parameter specifying the type of object the request body is expected to be.

Inheritors

AbstractInferenceRequestSpecification

Constructors

ModelRequestSpecification

constructor(model: String? = null, requestBody: MutableList<Matcher<P?>> = mutableListOf(), requestBodyString: MutableList<Matcher<String?>> = mutableListOf())

Properties

model

var model: String?

requestBody

val requestBody: MutableList<Matcher<P?>>

requestBodyString

val requestBodyString: MutableList<Matcher<String?>>

Functions

model

fun model(model: String): ModelRequestSpecification

requestBodyContains

fun requestBodyContains(substring: String): ModelRequestSpecification

Adds a matcher to require that the request body string contains the specified substring.

requestBodyContainsIgnoringCase

fun requestBodyContainsIgnoringCase(substring: String): ModelRequestSpecification

Adds a condition to ensure the request body contains the specified substring, ignoring case sensitivity.

requestBodyDoesNotContains

fun requestBodyDoesNotContains(substring: String): ModelRequestSpecification

Adds a condition to ensure the request body does not contain the specified substring.

requestBodyDoesNotContainsIgnoringCase

fun requestBodyDoesNotContainsIgnoringCase(substring: String): ModelRequestSpecification

Adds a condition to ensure the request body does not contain the specified substring, ignoring case sensitivity.

requestBodyEquals

fun requestBodyEquals(requestObject: P): ModelRequestSpecification

Adds a matcher to require the request body object to be exactly equal to the specified object.

fun requestBodyEquals(payload: String): ModelRequestSpecification

Adds a matcher to require the request body string to be exactly equal to the specified value.

requestBodyEqualsJson

fun requestBodyEqualsJson(payload: String): ModelRequestSpecification

Adds a matcher that requires the request body string to exactly match the specified JSON payload.

requestMatches

fun requestMatches(matcher: Matcher<P?>)

Adds a condition to verify that the request matches the specified matcher.

requestMatchesPredicate

fun requestMatchesPredicate(predicate: (P) -> Boolean)

Adds a condition to verify that the request matches the specified predicate.

requestSatisfies

fun requestSatisfies(description: String? = null, call: (P?) -> Unit)

Adds a condition to verify that the request satisfies the specified call.