| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>OASFilter</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| |
| <link rel="shortcut icon" href="/img/microprofile-favicon.png"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="OASFilter"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":18,"i1":18,"i2":18,"i3":18,"i4":18,"i5":18,"i6":18,"i7":18,"i8":18,"i9":18,"i10":18,"i11":18,"i12":18}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],16:["t5","Default Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/eclipse/microprofile/openapi/OASFactory.html" title="class in org.eclipse.microprofile.openapi"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/microprofile/openapi/OASModelReader.html" title="interface in org.eclipse.microprofile.openapi"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/microprofile/openapi/OASFilter.html" target="_top">Frames</a></li> |
| <li><a href="OASFilter.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.eclipse.microprofile.openapi</div> |
| <h2 title="Interface OASFilter" class="title">Interface OASFilter</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">OASFilter</span></pre> |
| <div class="block">This interface allows application developers to filter different parts of the OpenAPI model tree. |
| |
| A common scenario is to dynamically augment (update or remove) OpenAPI elements based on the environment |
| that the application is currently in. |
| |
| The registration of this filter is controlled by setting the key <b>mp.openapi.filter</b> using |
| one of the configuration sources specified in <a href="https://github.com/eclipse/microprofile-config">MicroProfile Config</a>. |
| The value is the fully qualified name of the filter implementation, which needs to be visible to the application's classloader.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>default <a href="../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html" title="interface in org.eclipse.microprofile.openapi.models.responses">APIResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/openapi/OASFilter.html#filterAPIResponse-org.eclipse.microprofile.openapi.models.responses.APIResponse-">filterAPIResponse</a></span>(<a href="../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html" title="interface in org.eclipse.microprofile.openapi.models.responses">APIResponse</a> apiResponse)</code> |
| <div class="block">Allows filtering of a particular APIResponse.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>default <a href="../../../../org/eclipse/microprofile/openapi/models/callbacks/Callback.html" title="interface in org.eclipse.microprofile.openapi.models.callbacks">Callback</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/openapi/OASFilter.html#filterCallback-org.eclipse.microprofile.openapi.models.callbacks.Callback-">filterCallback</a></span>(<a href="../../../../org/eclipse/microprofile/openapi/models/callbacks/Callback.html" title="interface in org.eclipse.microprofile.openapi.models.callbacks">Callback</a> callback)</code> |
| <div class="block">Allows filtering of a particular Callback.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>default <a href="../../../../org/eclipse/microprofile/openapi/models/headers/Header.html" title="interface in org.eclipse.microprofile.openapi.models.headers">Header</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/openapi/OASFilter.html#filterHeader-org.eclipse.microprofile.openapi.models.headers.Header-">filterHeader</a></span>(<a href="../../../../org/eclipse/microprofile/openapi/models/headers/Header.html" title="interface in org.eclipse.microprofile.openapi.models.headers">Header</a> header)</code> |
| <div class="block">Allows filtering of a particular Header.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>default <a href="../../../../org/eclipse/microprofile/openapi/models/links/Link.html" title="interface in org.eclipse.microprofile.openapi.models.links">Link</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/openapi/OASFilter.html#filterLink-org.eclipse.microprofile.openapi.models.links.Link-">filterLink</a></span>(<a href="../../../../org/eclipse/microprofile/openapi/models/links/Link.html" title="interface in org.eclipse.microprofile.openapi.models.links">Link</a> link)</code> |
| <div class="block">Allows filtering of a particular Link.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/openapi/OASFilter.html#filterOpenAPI-org.eclipse.microprofile.openapi.models.OpenAPI-">filterOpenAPI</a></span>(<a href="../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html" title="interface in org.eclipse.microprofile.openapi.models">OpenAPI</a> openAPI)</code> |
| <div class="block">Allows filtering of the singleton OpenAPI element.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>default <a href="../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/openapi/OASFilter.html#filterOperation-org.eclipse.microprofile.openapi.models.Operation-">filterOperation</a></span>(<a href="../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> operation)</code> |
| <div class="block">Allows filtering of a particular Operation.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>default <a href="../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/openapi/OASFilter.html#filterParameter-org.eclipse.microprofile.openapi.models.parameters.Parameter-">filterParameter</a></span>(<a href="../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a> parameter)</code> |
| <div class="block">Allows filtering of a particular Parameter.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>default <a href="../../../../org/eclipse/microprofile/openapi/models/PathItem.html" title="interface in org.eclipse.microprofile.openapi.models">PathItem</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/openapi/OASFilter.html#filterPathItem-org.eclipse.microprofile.openapi.models.PathItem-">filterPathItem</a></span>(<a href="../../../../org/eclipse/microprofile/openapi/models/PathItem.html" title="interface in org.eclipse.microprofile.openapi.models">PathItem</a> pathItem)</code> |
| <div class="block">Allows filtering of a particular PathItem.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>default <a href="../../../../org/eclipse/microprofile/openapi/models/parameters/RequestBody.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">RequestBody</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/openapi/OASFilter.html#filterRequestBody-org.eclipse.microprofile.openapi.models.parameters.RequestBody-">filterRequestBody</a></span>(<a href="../../../../org/eclipse/microprofile/openapi/models/parameters/RequestBody.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">RequestBody</a> requestBody)</code> |
| <div class="block">Allows filtering of a particular RequestBody.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>default <a href="../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/openapi/OASFilter.html#filterSchema-org.eclipse.microprofile.openapi.models.media.Schema-">filterSchema</a></span>(<a href="../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> schema)</code> |
| <div class="block">Allows filtering of a particular Schema.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>default <a href="../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityScheme</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/openapi/OASFilter.html#filterSecurityScheme-org.eclipse.microprofile.openapi.models.security.SecurityScheme-">filterSecurityScheme</a></span>(<a href="../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityScheme</a> securityScheme)</code> |
| <div class="block">Allows filtering of a particular SecurityScheme.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>default <a href="../../../../org/eclipse/microprofile/openapi/models/servers/Server.html" title="interface in org.eclipse.microprofile.openapi.models.servers">Server</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/openapi/OASFilter.html#filterServer-org.eclipse.microprofile.openapi.models.servers.Server-">filterServer</a></span>(<a href="../../../../org/eclipse/microprofile/openapi/models/servers/Server.html" title="interface in org.eclipse.microprofile.openapi.models.servers">Server</a> server)</code> |
| <div class="block">Allows filtering of a particular Server.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>default <a href="../../../../org/eclipse/microprofile/openapi/models/tags/Tag.html" title="interface in org.eclipse.microprofile.openapi.models.tags">Tag</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/openapi/OASFilter.html#filterTag-org.eclipse.microprofile.openapi.models.tags.Tag-">filterTag</a></span>(<a href="../../../../org/eclipse/microprofile/openapi/models/tags/Tag.html" title="interface in org.eclipse.microprofile.openapi.models.tags">Tag</a> tag)</code> |
| <div class="block">Allows filtering of a particular Tag.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="filterPathItem-org.eclipse.microprofile.openapi.models.PathItem-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>filterPathItem</h4> |
| <pre>default <a href="../../../../org/eclipse/microprofile/openapi/models/PathItem.html" title="interface in org.eclipse.microprofile.openapi.models">PathItem</a> filterPathItem(<a href="../../../../org/eclipse/microprofile/openapi/models/PathItem.html" title="interface in org.eclipse.microprofile.openapi.models">PathItem</a> pathItem)</pre> |
| <div class="block">Allows filtering of a particular PathItem. Implementers of this method can choose to update the given PathItem, |
| pass it back as-is, or return null if removing this PathItem.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pathItem</code> - the current PathItem element</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the PathItem to be used or null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="filterOperation-org.eclipse.microprofile.openapi.models.Operation-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>filterOperation</h4> |
| <pre>default <a href="../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> filterOperation(<a href="../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> operation)</pre> |
| <div class="block">Allows filtering of a particular Operation. Implementers of this method can choose to update the given Operation, |
| pass it back as-is, or return null if removing this Operation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>operation</code> - the current Operation element</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Operation to be used or null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="filterParameter-org.eclipse.microprofile.openapi.models.parameters.Parameter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>filterParameter</h4> |
| <pre>default <a href="../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a> filterParameter(<a href="../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a> parameter)</pre> |
| <div class="block">Allows filtering of a particular Parameter. Implementers of this method can choose to update the given Parameter, |
| pass it back as-is, or return null if removing this Parameter.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parameter</code> - the current Parameter element</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Parameter to be used or null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="filterHeader-org.eclipse.microprofile.openapi.models.headers.Header-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>filterHeader</h4> |
| <pre>default <a href="../../../../org/eclipse/microprofile/openapi/models/headers/Header.html" title="interface in org.eclipse.microprofile.openapi.models.headers">Header</a> filterHeader(<a href="../../../../org/eclipse/microprofile/openapi/models/headers/Header.html" title="interface in org.eclipse.microprofile.openapi.models.headers">Header</a> header)</pre> |
| <div class="block">Allows filtering of a particular Header. Implementers of this method can choose to update the given Header, |
| pass it back as-is, or return null if removing this Header.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>header</code> - the current Header element</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Header to be used or null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="filterRequestBody-org.eclipse.microprofile.openapi.models.parameters.RequestBody-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>filterRequestBody</h4> |
| <pre>default <a href="../../../../org/eclipse/microprofile/openapi/models/parameters/RequestBody.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">RequestBody</a> filterRequestBody(<a href="../../../../org/eclipse/microprofile/openapi/models/parameters/RequestBody.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">RequestBody</a> requestBody)</pre> |
| <div class="block">Allows filtering of a particular RequestBody. Implementers of this method can choose to update the given RequestBody, |
| pass it back as-is, or return null if removing this RequestBody.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>requestBody</code> - the current RequestBody element</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the RequestBody to be used or null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="filterAPIResponse-org.eclipse.microprofile.openapi.models.responses.APIResponse-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>filterAPIResponse</h4> |
| <pre>default <a href="../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html" title="interface in org.eclipse.microprofile.openapi.models.responses">APIResponse</a> filterAPIResponse(<a href="../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html" title="interface in org.eclipse.microprofile.openapi.models.responses">APIResponse</a> apiResponse)</pre> |
| <div class="block">Allows filtering of a particular APIResponse. Implementers of this method can choose to update the given APIResponse, |
| pass it back as-is, or return null if removing this APIResponse.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>apiResponse</code> - the current APIResponse element</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the APIResponse to be used or null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="filterSchema-org.eclipse.microprofile.openapi.models.media.Schema-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>filterSchema</h4> |
| <pre>default <a href="../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> filterSchema(<a href="../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> schema)</pre> |
| <div class="block">Allows filtering of a particular Schema. Implementers of this method can choose to update the given Schema, |
| pass it back as-is, or return null if removing this Schema.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>schema</code> - the current Schema element</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Schema to be used or null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="filterSecurityScheme-org.eclipse.microprofile.openapi.models.security.SecurityScheme-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>filterSecurityScheme</h4> |
| <pre>default <a href="../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityScheme</a> filterSecurityScheme(<a href="../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityScheme</a> securityScheme)</pre> |
| <div class="block">Allows filtering of a particular SecurityScheme. Implementers of this method can choose to update the given SecurityScheme, |
| pass it back as-is, or return null if removing this SecurityScheme.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>securityScheme</code> - the current SecurityScheme element</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the SecurityScheme to be used or null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="filterServer-org.eclipse.microprofile.openapi.models.servers.Server-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>filterServer</h4> |
| <pre>default <a href="../../../../org/eclipse/microprofile/openapi/models/servers/Server.html" title="interface in org.eclipse.microprofile.openapi.models.servers">Server</a> filterServer(<a href="../../../../org/eclipse/microprofile/openapi/models/servers/Server.html" title="interface in org.eclipse.microprofile.openapi.models.servers">Server</a> server)</pre> |
| <div class="block">Allows filtering of a particular Server. Implementers of this method can choose to update the given Server, |
| pass it back as-is, or return null if removing this Server.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>server</code> - the current Server element</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Server to be used or null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="filterTag-org.eclipse.microprofile.openapi.models.tags.Tag-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>filterTag</h4> |
| <pre>default <a href="../../../../org/eclipse/microprofile/openapi/models/tags/Tag.html" title="interface in org.eclipse.microprofile.openapi.models.tags">Tag</a> filterTag(<a href="../../../../org/eclipse/microprofile/openapi/models/tags/Tag.html" title="interface in org.eclipse.microprofile.openapi.models.tags">Tag</a> tag)</pre> |
| <div class="block">Allows filtering of a particular Tag. Implementers of this method can choose to update the given Tag, |
| pass it back as-is, or return null if removing this Tag.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>tag</code> - the current Tag element</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Tag to be used or null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="filterLink-org.eclipse.microprofile.openapi.models.links.Link-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>filterLink</h4> |
| <pre>default <a href="../../../../org/eclipse/microprofile/openapi/models/links/Link.html" title="interface in org.eclipse.microprofile.openapi.models.links">Link</a> filterLink(<a href="../../../../org/eclipse/microprofile/openapi/models/links/Link.html" title="interface in org.eclipse.microprofile.openapi.models.links">Link</a> link)</pre> |
| <div class="block">Allows filtering of a particular Link. Implementers of this method can choose to update the given Link, |
| pass it back as-is, or return null if removing this Link.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>link</code> - the current Link element</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Link to be used or null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="filterCallback-org.eclipse.microprofile.openapi.models.callbacks.Callback-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>filterCallback</h4> |
| <pre>default <a href="../../../../org/eclipse/microprofile/openapi/models/callbacks/Callback.html" title="interface in org.eclipse.microprofile.openapi.models.callbacks">Callback</a> filterCallback(<a href="../../../../org/eclipse/microprofile/openapi/models/callbacks/Callback.html" title="interface in org.eclipse.microprofile.openapi.models.callbacks">Callback</a> callback)</pre> |
| <div class="block">Allows filtering of a particular Callback. Implementers of this method can choose to update the given Callback, |
| pass it back as-is, or return null if removing this Callback.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>callback</code> - the current Callback element</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Callback to be used or null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="filterOpenAPI-org.eclipse.microprofile.openapi.models.OpenAPI-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>filterOpenAPI</h4> |
| <pre>default void filterOpenAPI(<a href="../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html" title="interface in org.eclipse.microprofile.openapi.models">OpenAPI</a> openAPI)</pre> |
| <div class="block">Allows filtering of the singleton OpenAPI element. Implementers of this method can choose to update this element, or |
| do nothing if no change is required. Note that one cannot remove this element from the model tree, hence the return type |
| of void. This is the last method called for a given filter, therefore it symbolizes the end of processing by the vendor |
| framework.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>openAPI</code> - the current OpenAPI element</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/eclipse/microprofile/openapi/OASFactory.html" title="class in org.eclipse.microprofile.openapi"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/microprofile/openapi/OASModelReader.html" title="interface in org.eclipse.microprofile.openapi"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/microprofile/openapi/OASFilter.html" target="_top">Frames</a></li> |
| <li><a href="OASFilter.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
