Package io.swagger.v3.core.filter

Class AbstractSpecFilter

java.lang.Object

io.swagger.v3.core.filter.AbstractSpecFilter

All Implemented Interfaces:

OpenAPISpecFilter

Direct Known Subclasses:

OpenAPI31SpecFilter

public abstract class AbstractSpecFilter
extends Object
implements OpenAPISpecFilter

Constructor Summary

Constructors

Constructor	Description
AbstractSpecFilter()

Method Summary

Modifier and Type	Method	Description
Optional<OpenAPI>	filterOpenAPI(OpenAPI openAPI, Map<String,List<String>> params, Map<String,String> cookies, Map<String,List<String>> headers)
Optional<Operation>	filterOperation(Operation operation, ApiDescription api, Map<String,List<String>> params, Map<String,String> cookies, Map<String,List<String>> headers)
Optional<Parameter>	filterParameter(Parameter parameter, Operation operation, ApiDescription api, Map<String,List<String>> params, Map<String,String> cookies, Map<String,List<String>> headers)
Optional<PathItem>	filterPathItem(PathItem pathItem, ApiDescription api, Map<String,List<String>> params, Map<String,String> cookies, Map<String,List<String>> headers)
Optional<RequestBody>	filterRequestBody(RequestBody requestBody, Operation operation, ApiDescription api, Map<String,List<String>> params, Map<String,String> cookies, Map<String,List<String>> headers)
Optional<ApiResponse>	filterResponse(ApiResponse response, Operation operation, ApiDescription api, Map<String,List<String>> params, Map<String,String> cookies, Map<String,List<String>> headers)
Optional<Schema>	filterSchema(Schema schema, Map<String,List<String>> params, Map<String,String> cookies, Map<String,List<String>> headers)
Optional<Schema>	filterSchemaProperty(Schema property, Schema schema, String propName, Map<String,List<String>> params, Map<String,String> cookies, Map<String,List<String>> headers)
boolean	isRemovingUnreferencedDefinitions()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.swagger.v3.core.filter.OpenAPISpecFilter

isOpenAPI31Filter

Constructor Detail

AbstractSpecFilter

public AbstractSpecFilter()

Method Detail

filterOpenAPI

public Optional<OpenAPI> filterOpenAPI(OpenAPI openAPI,
                                       Map<String,List<String>> params,
                                       Map<String,String> cookies,
                                       Map<String,List<String>> headers)

Specified by:

filterOpenAPI in interface OpenAPISpecFilter

filterPathItem

public Optional<PathItem> filterPathItem(PathItem pathItem,
                                         ApiDescription api,
                                         Map<String,List<String>> params,
                                         Map<String,String> cookies,
                                         Map<String,List<String>> headers)

Specified by:

filterPathItem in interface OpenAPISpecFilter

filterOperation

public Optional<Operation> filterOperation(Operation operation,
                                           ApiDescription api,
                                           Map<String,List<String>> params,
                                           Map<String,String> cookies,
                                           Map<String,List<String>> headers)

Specified by:

filterOperation in interface OpenAPISpecFilter

filterParameter

public Optional<Parameter> filterParameter(Parameter parameter,
                                           Operation operation,
                                           ApiDescription api,
                                           Map<String,List<String>> params,
                                           Map<String,String> cookies,
                                           Map<String,List<String>> headers)

Specified by:

filterParameter in interface OpenAPISpecFilter

filterRequestBody

public Optional<RequestBody> filterRequestBody(RequestBody requestBody,
                                               Operation operation,
                                               ApiDescription api,
                                               Map<String,List<String>> params,
                                               Map<String,String> cookies,
                                               Map<String,List<String>> headers)

Specified by:

filterRequestBody in interface OpenAPISpecFilter

filterResponse

public Optional<ApiResponse> filterResponse(ApiResponse response,
                                            Operation operation,
                                            ApiDescription api,
                                            Map<String,List<String>> params,
                                            Map<String,String> cookies,
                                            Map<String,List<String>> headers)

Specified by:

filterResponse in interface OpenAPISpecFilter

filterSchema

public Optional<Schema> filterSchema(Schema schema,
                                     Map<String,List<String>> params,
                                     Map<String,String> cookies,
                                     Map<String,List<String>> headers)

Specified by:

filterSchema in interface OpenAPISpecFilter

filterSchemaProperty

public Optional<Schema> filterSchemaProperty(Schema property,
                                             Schema schema,
                                             String propName,
                                             Map<String,List<String>> params,
                                             Map<String,String> cookies,
                                             Map<String,List<String>> headers)

Specified by:

filterSchemaProperty in interface OpenAPISpecFilter

isRemovingUnreferencedDefinitions

public boolean isRemovingUnreferencedDefinitions()

Specified by:

isRemovingUnreferencedDefinitions in interface OpenAPISpecFilter