io.swagger.v3.core.filter

Interface OpenAPISpecFilter

All Known Implementing Classes:

AbstractSpecFilter, OpenAPI31SpecFilter

public interface OpenAPISpecFilter

Method Summary

Modifier and Type	Method and 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)
default boolean	isOpenAPI31Filter()
boolean	isRemovingUnreferencedDefinitions()

Method Detail

filterOpenAPI

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

filterPathItem

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

filterOperation

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

filterParameter

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

filterRequestBody

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

filterResponse

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

filterSchema

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

filterSchemaProperty

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

isRemovingUnreferencedDefinitions

boolean isRemovingUnreferencedDefinitions()

isOpenAPI31Filter

default boolean isOpenAPI31Filter()