Package org.openapitools.codegen.languages

Class SpringPageableScanUtils

java.lang.Object

org.openapitools.codegen.languages.SpringPageableScanUtils

public final class SpringPageableScanUtils
extends Object

Language-agnostic utility methods for scanning OpenAPI specs for Spring Pageable-related features: sort enum validation, pageable defaults, and pageable constraints (max page/size).

Used by both kotlin KotlinSpringServerCodegen and java SpringCodegen to share scan logic. Only the mustache templates and their registration remain language-specific.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SpringPageableScanUtils.PageableConstraintsData	Carries max constraints for page number and page size from a pageable operation.
static class	SpringPageableScanUtils.PageableDefaultsData	Carries parsed default values for page, size, and sort fields from a pageable operation.
static class	SpringPageableScanUtils.SortFieldDefault	Carries a parsed sort field and its direction (always "ASC" or "DESC") from the spec default.

Method Summary

Modifier and Type	Method	Description
static Map<String,SpringPageableScanUtils.PageableConstraintsData>	scanPageableConstraints(io.swagger.v3.oas.models.OpenAPI openAPI, boolean autoXSpringPaginated)	Scans all pageable operations for maximum: constraints on page and size parameters.
static Map<String,SpringPageableScanUtils.PageableDefaultsData>	scanPageableDefaults(io.swagger.v3.oas.models.OpenAPI openAPI, boolean autoXSpringPaginated)	Scans all pageable operations for default values on page, size, and sort parameters.
static Map<String,List<String>>	scanSortValidationEnums(io.swagger.v3.oas.models.OpenAPI openAPI, boolean autoXSpringPaginated)	Scans all pageable operations for a sort parameter with enum values.
static boolean	willBePageable(io.swagger.v3.oas.models.Operation operation, boolean autoXSpringPaginated)	Returns true if the given operation will have a Pageable parameter injected — either because it has x-spring-paginated: true explicitly, or because autoXSpringPaginated is enabled and the operation has all three default pagination query parameters (page, size, sort).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

willBePageable

public static boolean willBePageable(io.swagger.v3.oas.models.Operation operation,
                                     boolean autoXSpringPaginated)

Returns true if the given operation will have a Pageable parameter injected — either because it has x-spring-paginated: true explicitly, or because autoXSpringPaginated is enabled and the operation has all three default pagination query parameters (page, size, sort).

scanSortValidationEnums

public static Map<String,List<String>> scanSortValidationEnums(io.swagger.v3.oas.models.OpenAPI openAPI,
                                                                     boolean autoXSpringPaginated)

Scans all pageable operations for a sort parameter with enum values.

Returns:

map from operationId to list of allowed sort strings (e.g. ["id,asc", "id,desc"])

scanPageableDefaults

public static Map<String,SpringPageableScanUtils.PageableDefaultsData> scanPageableDefaults(io.swagger.v3.oas.models.OpenAPI openAPI,
                                                                                                  boolean autoXSpringPaginated)

Scans all pageable operations for default values on page, size, and sort parameters.

Returns:

map from operationId to SpringPageableScanUtils.PageableDefaultsData (only operations with at least one default are included)

scanPageableConstraints

public static Map<String,SpringPageableScanUtils.PageableConstraintsData> scanPageableConstraints(io.swagger.v3.oas.models.OpenAPI openAPI,
                                                                                                        boolean autoXSpringPaginated)

Scans all pageable operations for maximum: constraints on page and size parameters.

Returns:

map from operationId to SpringPageableScanUtils.PageableConstraintsData (only operations with at least one maximum: constraint are included)