Package io.swagger.v3.core.filter

Class SpecFilter

java.lang.Object

io.swagger.v3.core.filter.SpecFilter

public class SpecFilter
extends Object

Constructor Summary

Constructors

Constructor	Description
SpecFilter()

Method Summary

Modifier and Type	Method	Description
OpenAPI	filter(OpenAPI openAPI, OpenAPISpecFilter filter, Map<String,List<String>> params, Map<String,String> cookies, Map<String,List<String>> headers)
protected Map<String,Schema>	filterComponentsSchema(OpenAPISpecFilter filter, Map<String,Schema> schemasMap, Map<String,List<String>> params, Map<String,String> cookies, Map<String,List<String>> headers)
protected OpenAPI	filterOpenAPI(OpenAPISpecFilter filter, OpenAPI openAPI, Map<String,List<String>> params, Map<String,String> cookies, Map<String,List<String>> headers)
protected Operation	filterOperation(OpenAPISpecFilter filter, Operation operation, String resourcePath, String key, Map<String,List<String>> params, Map<String,String> cookies, Map<String,List<String>> headers)
protected Parameter	filterParameter(OpenAPISpecFilter filter, Operation operation, Parameter parameter, String resourcePath, String key, Map<String,List<String>> params, Map<String,String> cookies, Map<String,List<String>> headers)
protected PathItem	filterPathItem(OpenAPISpecFilter filter, PathItem pathItem, String resourcePath, Map<String,List<String>> params, Map<String,String> cookies, Map<String,List<String>> headers)
protected RequestBody	filterRequestBody(OpenAPISpecFilter filter, Operation operation, RequestBody requestBody, String resourcePath, String key, Map<String,List<String>> params, Map<String,String> cookies, Map<String,List<String>> headers)
protected ApiResponse	filterResponse(OpenAPISpecFilter filter, Operation operation, ApiResponse response, String resourcePath, String key, Map<String,List<String>> params, Map<String,String> cookies, Map<String,List<String>> headers)
protected void	locateReferencedDefinitions(String ref, Set<String> nestedReferencedDefinitions, OpenAPI openAPI)
protected OpenAPI	removeBrokenReferenceDefinitions(OpenAPI openApi)
protected Set<String>	resolveAllNestedRefs(Set<String> refs, Set<String> accumulatedRefs, OpenAPI openApi)

Methods inherited from class java.lang.Object

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

Constructor Detail

SpecFilter

public SpecFilter()

Method Detail

filter

public OpenAPI filter(OpenAPI openAPI,
                      OpenAPISpecFilter filter,
                      Map<String,List<String>> params,
                      Map<String,String> cookies,
                      Map<String,List<String>> headers)

filterOpenAPI

protected OpenAPI filterOpenAPI(OpenAPISpecFilter filter,
                                OpenAPI openAPI,
                                Map<String,List<String>> params,
                                Map<String,String> cookies,
                                Map<String,List<String>> headers)

filterOperation

protected Operation filterOperation(OpenAPISpecFilter filter,
                                    Operation operation,
                                    String resourcePath,
                                    String key,
                                    Map<String,List<String>> params,
                                    Map<String,String> cookies,
                                    Map<String,List<String>> headers)

filterPathItem

protected PathItem filterPathItem(OpenAPISpecFilter filter,
                                  PathItem pathItem,
                                  String resourcePath,
                                  Map<String,List<String>> params,
                                  Map<String,String> cookies,
                                  Map<String,List<String>> headers)

filterParameter

protected Parameter filterParameter(OpenAPISpecFilter filter,
                                    Operation operation,
                                    Parameter parameter,
                                    String resourcePath,
                                    String key,
                                    Map<String,List<String>> params,
                                    Map<String,String> cookies,
                                    Map<String,List<String>> headers)

filterRequestBody

protected RequestBody filterRequestBody(OpenAPISpecFilter filter,
                                        Operation operation,
                                        RequestBody requestBody,
                                        String resourcePath,
                                        String key,
                                        Map<String,List<String>> params,
                                        Map<String,String> cookies,
                                        Map<String,List<String>> headers)

filterResponse

protected ApiResponse filterResponse(OpenAPISpecFilter filter,
                                     Operation operation,
                                     ApiResponse response,
                                     String resourcePath,
                                     String key,
                                     Map<String,List<String>> params,
                                     Map<String,String> cookies,
                                     Map<String,List<String>> headers)

filterComponentsSchema

protected Map<String,Schema> filterComponentsSchema(OpenAPISpecFilter filter,
                                                          Map<String,Schema> schemasMap,
                                                          Map<String,List<String>> params,
                                                          Map<String,String> cookies,
                                                          Map<String,List<String>> headers)

removeBrokenReferenceDefinitions

protected OpenAPI removeBrokenReferenceDefinitions(OpenAPI openApi)

resolveAllNestedRefs

protected Set<String> resolveAllNestedRefs(Set<String> refs,
                                           Set<String> accumulatedRefs,
                                           OpenAPI openApi)

locateReferencedDefinitions

protected void locateReferencedDefinitions(String ref,
                                           Set<String> nestedReferencedDefinitions,
                                           OpenAPI openAPI)