example-value/art.galushko.openapi.testgen.example.openapi/SchemaTypeHelpers

SchemaTypeHelpers

object SchemaTypeHelpers

Utility helpers to work with OpenAPI schema types and $ref dereferencing.

Functions

findSuccessStatusCode

fun findSuccessStatusCode(operation: Operation): Int

Finds the first success status code (2xx) from operation responses.

fun isArray(schema: Schema<*>): Boolean

Determines if the given schema represents an array type.

fun isBoolean(schema: Schema<*>): Boolean

Determines if the given schema represents a boolean type.

fun isInteger(schema: Schema<*>): Boolean

Determines if the given schema represents an integer type.

fun isNumber(schema: Schema<*>): Boolean

Determines if the given schema represents a numeric type (either "integer" or "number").

fun isObject(schema: Schema<*>): Boolean

Determines if the given schema represents an object type.

fun isString(schema: Schema<*>): Boolean

Checks if the given schema represents a string type.

resolveExampleRef

fun resolveExampleRef(example: Example, openAPI: OpenAPI): Example

Resolves an example $ref against OpenAPI components.

resolveResponseByStatus

fun resolveResponseByStatus(operation: Operation, openAPI: OpenAPI, statusCode: Int): ApiResponse?

Resolves a response by status code using OpenAPI matching rules: exact code -> range (e.g. 2XX) -> default.

resolveSchemaRef

fun resolveSchemaRef(schema: Schema<*>?, openAPI: OpenAPI?): Schema<*>?

Null-tolerant variant of tryGetSchemaFromRef for standard #/components/schemas/ resolution. Returns null for a null schema, and the schema unchanged when openAPI is null or the reference cannot be resolved.

tryGetParametersFromRef

fun tryGetParametersFromRef(parameter: Parameter, openAPI: OpenAPI): Parameter

Attempts to dereference a parameter $ref against the OpenAPI components. Returns the dereferenced parameter if found; otherwise returns the original.

tryGetRequestBodyFromRef

fun tryGetRequestBodyFromRef(requestBody: RequestBody, openAPI: OpenAPI): RequestBody

Attempts to dereference a request body $ref against the OpenAPI components. Returns the dereferenced request body if found; otherwise returns the original.

tryGetSchemaFromRef

fun tryGetSchemaFromRef(schema: Schema<*>, openAPI: OpenAPI): Schema<*>

Attempts to dereference a schema $ref against the OpenAPI components. Returns the dereferenced schema if found; otherwise returns the original schema.