| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>OpenAPI</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="OpenAPI"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":18,"i4":18,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":18,"i14":18,"i15":18,"i16":6,"i17":6,"i18":6,"i19":18,"i20":18,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":18}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/models/ExternalDocumentation.html" title="interface in org.eclipse.microprofile.openapi.models"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/microprofile/openapi/models/OpenAPI.html" target="_top">Frames</a></li> |
| <li><a href="OpenAPI.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.models</div> |
| <h2 title="Interface OpenAPI" class="title">Interface OpenAPI</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../../org/eclipse/microprofile/openapi/models/Constructible.html" title="interface in org.eclipse.microprofile.openapi.models">Constructible</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/Extensible.html" title="interface in org.eclipse.microprofile.openapi.models">Extensible</a><<a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html" title="interface in org.eclipse.microprofile.openapi.models">OpenAPI</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">OpenAPI</span> |
| extends <a href="../../../../../org/eclipse/microprofile/openapi/models/Constructible.html" title="interface in org.eclipse.microprofile.openapi.models">Constructible</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/Extensible.html" title="interface in org.eclipse.microprofile.openapi.models">Extensible</a><<a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html" title="interface in org.eclipse.microprofile.openapi.models">OpenAPI</a>></pre> |
| <div class="block">OpenAPI |
| <p> |
| This is the root document object of the OpenAPI document. It contains required and optional fields.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href= "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#openapi-object">OpenAPI Specification OpenAPI Object</a></dd> |
| </dl> |
| </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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html" title="interface in org.eclipse.microprofile.openapi.models">OpenAPI</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html#addSecurityRequirement-org.eclipse.microprofile.openapi.models.security.SecurityRequirement-">addSecurityRequirement</a></span>(<a href="../../../../../org/eclipse/microprofile/openapi/models/security/SecurityRequirement.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityRequirement</a> securityRequirement)</code> |
| <div class="block">Adds the given security requirement to this OpenAPI instance's list of security requirements.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html" title="interface in org.eclipse.microprofile.openapi.models">OpenAPI</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html#addServer-org.eclipse.microprofile.openapi.models.servers.Server-">addServer</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">Adds the given server to this OpenAPI instance's list of servers.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html" title="interface in org.eclipse.microprofile.openapi.models">OpenAPI</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html#addTag-org.eclipse.microprofile.openapi.models.tags.Tag-">addTag</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">Adds the given tag to this OpenAPI instance's list of tags.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>default <a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html" title="interface in org.eclipse.microprofile.openapi.models">OpenAPI</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html#components-org.eclipse.microprofile.openapi.models.Components-">components</a></span>(<a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html" title="interface in org.eclipse.microprofile.openapi.models">Components</a> components)</code> |
| <div class="block">Sets this OpenAPI instance's components property to the given components.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>default <a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html" title="interface in org.eclipse.microprofile.openapi.models">OpenAPI</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html#externalDocs-org.eclipse.microprofile.openapi.models.ExternalDocumentation-">externalDocs</a></span>(<a href="../../../../../org/eclipse/microprofile/openapi/models/ExternalDocumentation.html" title="interface in org.eclipse.microprofile.openapi.models">ExternalDocumentation</a> externalDocs)</code> |
| <div class="block">Sets this OpenAPI instance's externalDocs property to the given object.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html" title="interface in org.eclipse.microprofile.openapi.models">Components</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html#getComponents--">getComponents</a></span>()</code> |
| <div class="block">Returns the components property from an OpenAPI instance.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/eclipse/microprofile/openapi/models/ExternalDocumentation.html" title="interface in org.eclipse.microprofile.openapi.models">ExternalDocumentation</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html#getExternalDocs--">getExternalDocs</a></span>()</code> |
| <div class="block">Returns the externalDocs property from an OpenAPI instance.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/eclipse/microprofile/openapi/models/info/Info.html" title="interface in org.eclipse.microprofile.openapi.models.info">Info</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html#getInfo--">getInfo</a></span>()</code> |
| <div class="block">Returns the info property from an OpenAPI instance.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html#getOpenapi--">getOpenapi</a></span>()</code> |
| <div class="block">Returns the openapi property from an OpenAPI instance.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/eclipse/microprofile/openapi/models/Paths.html" title="interface in org.eclipse.microprofile.openapi.models">Paths</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html#getPaths--">getPaths</a></span>()</code> |
| <div class="block">Returns the paths property from an OpenAPI instance.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>java.util.List<<a href="../../../../../org/eclipse/microprofile/openapi/models/security/SecurityRequirement.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityRequirement</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html#getSecurity--">getSecurity</a></span>()</code> |
| <div class="block">Returns the security property from an OpenAPI instance.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<<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/models/OpenAPI.html#getServers--">getServers</a></span>()</code> |
| <div class="block">Returns the Servers defined in the API</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>java.util.List<<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/models/OpenAPI.html#getTags--">getTags</a></span>()</code> |
| <div class="block">Returns the tags property from an OpenAPI instance.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>default <a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html" title="interface in org.eclipse.microprofile.openapi.models">OpenAPI</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html#info-org.eclipse.microprofile.openapi.models.info.Info-">info</a></span>(<a href="../../../../../org/eclipse/microprofile/openapi/models/info/Info.html" title="interface in org.eclipse.microprofile.openapi.models.info">Info</a> info)</code> |
| <div class="block">Sets this OpenAPI instance's info property to the given object.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>default <a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html" title="interface in org.eclipse.microprofile.openapi.models">OpenAPI</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html#openapi-java.lang.String-">openapi</a></span>(java.lang.String openapi)</code> |
| <div class="block">Sets this OpenAPI instance's openapi property to the given string.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>default <a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html" title="interface in org.eclipse.microprofile.openapi.models">OpenAPI</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html#paths-org.eclipse.microprofile.openapi.models.Paths-">paths</a></span>(<a href="../../../../../org/eclipse/microprofile/openapi/models/Paths.html" title="interface in org.eclipse.microprofile.openapi.models">Paths</a> paths)</code> |
| <div class="block">Sets this OpenAPI instance's paths property to the given paths.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html#removeSecurityRequirement-org.eclipse.microprofile.openapi.models.security.SecurityRequirement-">removeSecurityRequirement</a></span>(<a href="../../../../../org/eclipse/microprofile/openapi/models/security/SecurityRequirement.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityRequirement</a> securityRequirement)</code> |
| <div class="block">Removes the given security requirement to this OpenAPI instance's list of security requirements.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html#removeServer-org.eclipse.microprofile.openapi.models.servers.Server-">removeServer</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">Removes the given server to this OpenAPI instance's list of servers.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html#removeTag-org.eclipse.microprofile.openapi.models.tags.Tag-">removeTag</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">Removes the given tag to this OpenAPI instance's list of tags.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>default <a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html" title="interface in org.eclipse.microprofile.openapi.models">OpenAPI</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html#security-java.util.List-">security</a></span>(java.util.List<<a href="../../../../../org/eclipse/microprofile/openapi/models/security/SecurityRequirement.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityRequirement</a>> security)</code> |
| <div class="block">Sets this OpenAPI instance's security property to the given list.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>default <a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html" title="interface in org.eclipse.microprofile.openapi.models">OpenAPI</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html#servers-java.util.List-">servers</a></span>(java.util.List<<a href="../../../../../org/eclipse/microprofile/openapi/models/servers/Server.html" title="interface in org.eclipse.microprofile.openapi.models.servers">Server</a>> servers)</code> |
| <div class="block">Sets this OpenAPI instance's servers property to the given servers.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html#setComponents-org.eclipse.microprofile.openapi.models.Components-">setComponents</a></span>(<a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html" title="interface in org.eclipse.microprofile.openapi.models">Components</a> components)</code> |
| <div class="block">Sets this OpenAPI instance's components property to the given components.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html#setExternalDocs-org.eclipse.microprofile.openapi.models.ExternalDocumentation-">setExternalDocs</a></span>(<a href="../../../../../org/eclipse/microprofile/openapi/models/ExternalDocumentation.html" title="interface in org.eclipse.microprofile.openapi.models">ExternalDocumentation</a> externalDocs)</code> |
| <div class="block">Sets this OpenAPI instance's externalDocs property to the given object.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html#setInfo-org.eclipse.microprofile.openapi.models.info.Info-">setInfo</a></span>(<a href="../../../../../org/eclipse/microprofile/openapi/models/info/Info.html" title="interface in org.eclipse.microprofile.openapi.models.info">Info</a> info)</code> |
| <div class="block">Sets this OpenAPI instance's info property to the given object.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html#setOpenapi-java.lang.String-">setOpenapi</a></span>(java.lang.String openapi)</code> |
| <div class="block">Sets this OpenAPI instance's openapi property to the given string.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html#setPaths-org.eclipse.microprofile.openapi.models.Paths-">setPaths</a></span>(<a href="../../../../../org/eclipse/microprofile/openapi/models/Paths.html" title="interface in org.eclipse.microprofile.openapi.models">Paths</a> paths)</code> |
| <div class="block">Sets this OpenAPI instance's paths property to the given paths.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html#setSecurity-java.util.List-">setSecurity</a></span>(java.util.List<<a href="../../../../../org/eclipse/microprofile/openapi/models/security/SecurityRequirement.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityRequirement</a>> security)</code> |
| <div class="block">Sets this OpenAPI instance's security property to the given list.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html#setServers-java.util.List-">setServers</a></span>(java.util.List<<a href="../../../../../org/eclipse/microprofile/openapi/models/servers/Server.html" title="interface in org.eclipse.microprofile.openapi.models.servers">Server</a>> servers)</code> |
| <div class="block">Sets this OpenAPI instance's servers property to the given servers.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html#setTags-java.util.List-">setTags</a></span>(java.util.List<<a href="../../../../../org/eclipse/microprofile/openapi/models/tags/Tag.html" title="interface in org.eclipse.microprofile.openapi.models.tags">Tag</a>> tags)</code> |
| <div class="block">Sets this OpenAPI instance's tags property to the given Tags.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>default <a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html" title="interface in org.eclipse.microprofile.openapi.models">OpenAPI</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html#tags-java.util.List-">tags</a></span>(java.util.List<<a href="../../../../../org/eclipse/microprofile/openapi/models/tags/Tag.html" title="interface in org.eclipse.microprofile.openapi.models.tags">Tag</a>> tags)</code> |
| <div class="block">Sets this OpenAPI instance's tags property to the given tags.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.microprofile.openapi.models.Extensible"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.microprofile.openapi.models.<a href="../../../../../org/eclipse/microprofile/openapi/models/Extensible.html" title="interface in org.eclipse.microprofile.openapi.models">Extensible</a></h3> |
| <code><a href="../../../../../org/eclipse/microprofile/openapi/models/Extensible.html#addExtension-java.lang.String-java.lang.Object-">addExtension</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/Extensible.html#extensions-java.util.Map-">extensions</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/Extensible.html#getExtensions--">getExtensions</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/Extensible.html#removeExtension-java.lang.String-">removeExtension</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/Extensible.html#setExtensions-java.util.Map-">setExtensions</a></code></li> |
| </ul> |
| </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="getOpenapi--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOpenapi</h4> |
| <pre>java.lang.String getOpenapi()</pre> |
| <div class="block">Returns the openapi property from an OpenAPI instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the semantic version number of the OpenAPI Specification version that the OpenAPI document uses</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setOpenapi-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOpenapi</h4> |
| <pre>void setOpenapi(java.lang.String openapi)</pre> |
| <div class="block">Sets this OpenAPI instance's openapi property to the given string.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>openapi</code> - the semantic version number of the OpenAPI Specification version that the OpenAPI document uses</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="openapi-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openapi</h4> |
| <pre>default <a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html" title="interface in org.eclipse.microprofile.openapi.models">OpenAPI</a> openapi(java.lang.String openapi)</pre> |
| <div class="block">Sets this OpenAPI instance's openapi property to the given string.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>openapi</code> - the semantic version number of the OpenAPI Specification version that the OpenAPI document uses</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current OpenAPI object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInfo--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInfo</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/info/Info.html" title="interface in org.eclipse.microprofile.openapi.models.info">Info</a> getInfo()</pre> |
| <div class="block">Returns the info property from an OpenAPI instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>metadata about the API</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setInfo-org.eclipse.microprofile.openapi.models.info.Info-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInfo</h4> |
| <pre>void setInfo(<a href="../../../../../org/eclipse/microprofile/openapi/models/info/Info.html" title="interface in org.eclipse.microprofile.openapi.models.info">Info</a> info)</pre> |
| <div class="block">Sets this OpenAPI instance's info property to the given object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>info</code> - metadata about the API</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="info-org.eclipse.microprofile.openapi.models.info.Info-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>info</h4> |
| <pre>default <a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html" title="interface in org.eclipse.microprofile.openapi.models">OpenAPI</a> info(<a href="../../../../../org/eclipse/microprofile/openapi/models/info/Info.html" title="interface in org.eclipse.microprofile.openapi.models.info">Info</a> info)</pre> |
| <div class="block">Sets this OpenAPI instance's info property to the given object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>info</code> - metadata about the API</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current OpenAPI object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getExternalDocs--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExternalDocs</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/ExternalDocumentation.html" title="interface in org.eclipse.microprofile.openapi.models">ExternalDocumentation</a> getExternalDocs()</pre> |
| <div class="block">Returns the externalDocs property from an OpenAPI instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>additional external documentation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setExternalDocs-org.eclipse.microprofile.openapi.models.ExternalDocumentation-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExternalDocs</h4> |
| <pre>void setExternalDocs(<a href="../../../../../org/eclipse/microprofile/openapi/models/ExternalDocumentation.html" title="interface in org.eclipse.microprofile.openapi.models">ExternalDocumentation</a> externalDocs)</pre> |
| <div class="block">Sets this OpenAPI instance's externalDocs property to the given object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>externalDocs</code> - additional external documentation.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="externalDocs-org.eclipse.microprofile.openapi.models.ExternalDocumentation-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>externalDocs</h4> |
| <pre>default <a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html" title="interface in org.eclipse.microprofile.openapi.models">OpenAPI</a> externalDocs(<a href="../../../../../org/eclipse/microprofile/openapi/models/ExternalDocumentation.html" title="interface in org.eclipse.microprofile.openapi.models">ExternalDocumentation</a> externalDocs)</pre> |
| <div class="block">Sets this OpenAPI instance's externalDocs property to the given object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>externalDocs</code> - additional external documentation</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current OpenAPI object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getServers--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServers</h4> |
| <pre>java.util.List<<a href="../../../../../org/eclipse/microprofile/openapi/models/servers/Server.html" title="interface in org.eclipse.microprofile.openapi.models.servers">Server</a>> getServers()</pre> |
| <div class="block">Returns the Servers defined in the API</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a copy List (potentially immutable) of Server objects which provide connectivity information to target servers</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setServers-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setServers</h4> |
| <pre>void setServers(java.util.List<<a href="../../../../../org/eclipse/microprofile/openapi/models/servers/Server.html" title="interface in org.eclipse.microprofile.openapi.models.servers">Server</a>> servers)</pre> |
| <div class="block">Sets this OpenAPI instance's servers property to the given servers.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>servers</code> - Server objects which provide connectivity information to target servers</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="servers-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>servers</h4> |
| <pre>default <a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html" title="interface in org.eclipse.microprofile.openapi.models">OpenAPI</a> servers(java.util.List<<a href="../../../../../org/eclipse/microprofile/openapi/models/servers/Server.html" title="interface in org.eclipse.microprofile.openapi.models.servers">Server</a>> servers)</pre> |
| <div class="block">Sets this OpenAPI instance's servers property to the given servers.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>servers</code> - Server objects which provide connectivity information to target servers</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current OpenAPI object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addServer-org.eclipse.microprofile.openapi.models.servers.Server-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addServer</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html" title="interface in org.eclipse.microprofile.openapi.models">OpenAPI</a> addServer(<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">Adds the given server to this OpenAPI instance's list of servers.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>server</code> - Server object which provides connectivity information to a target server</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current OpenAPI object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeServer-org.eclipse.microprofile.openapi.models.servers.Server-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeServer</h4> |
| <pre>void removeServer(<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">Removes the given server to this OpenAPI instance's list of servers.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>server</code> - Server object which provides connectivity information to a target server</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSecurity--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSecurity</h4> |
| <pre>java.util.List<<a href="../../../../../org/eclipse/microprofile/openapi/models/security/SecurityRequirement.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityRequirement</a>> getSecurity()</pre> |
| <div class="block">Returns the security property from an OpenAPI instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a copy List (potentially immutable) containing the security mechanisms that can be used across the API</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSecurity-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSecurity</h4> |
| <pre>void setSecurity(java.util.List<<a href="../../../../../org/eclipse/microprofile/openapi/models/security/SecurityRequirement.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityRequirement</a>> security)</pre> |
| <div class="block">Sets this OpenAPI instance's security property to the given list.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>security</code> - which security mechanisms can be used across the API</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="security-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>security</h4> |
| <pre>default <a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html" title="interface in org.eclipse.microprofile.openapi.models">OpenAPI</a> security(java.util.List<<a href="../../../../../org/eclipse/microprofile/openapi/models/security/SecurityRequirement.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityRequirement</a>> security)</pre> |
| <div class="block">Sets this OpenAPI instance's security property to the given list.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>security</code> - which security mechanisms can be used across the API</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current OpenAPI object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addSecurityRequirement-org.eclipse.microprofile.openapi.models.security.SecurityRequirement-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addSecurityRequirement</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html" title="interface in org.eclipse.microprofile.openapi.models">OpenAPI</a> addSecurityRequirement(<a href="../../../../../org/eclipse/microprofile/openapi/models/security/SecurityRequirement.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityRequirement</a> securityRequirement)</pre> |
| <div class="block">Adds the given security requirement to this OpenAPI instance's list of security requirements.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>securityRequirement</code> - security mechanism which can be used across the API</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current OpenAPI object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeSecurityRequirement-org.eclipse.microprofile.openapi.models.security.SecurityRequirement-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeSecurityRequirement</h4> |
| <pre>void removeSecurityRequirement(<a href="../../../../../org/eclipse/microprofile/openapi/models/security/SecurityRequirement.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityRequirement</a> securityRequirement)</pre> |
| <div class="block">Removes the given security requirement to this OpenAPI instance's list of security requirements.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>securityRequirement</code> - security mechanism which can be used across the API</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTags--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTags</h4> |
| <pre>java.util.List<<a href="../../../../../org/eclipse/microprofile/openapi/models/tags/Tag.html" title="interface in org.eclipse.microprofile.openapi.models.tags">Tag</a>> getTags()</pre> |
| <div class="block">Returns the tags property from an OpenAPI instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a copy List (potentially immutable) of tags defined in this the specification</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setTags-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTags</h4> |
| <pre>void setTags(java.util.List<<a href="../../../../../org/eclipse/microprofile/openapi/models/tags/Tag.html" title="interface in org.eclipse.microprofile.openapi.models.tags">Tag</a>> tags)</pre> |
| <div class="block">Sets this OpenAPI instance's tags property to the given Tags.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>tags</code> - tags used by the specification with additional metadata</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="tags-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>tags</h4> |
| <pre>default <a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html" title="interface in org.eclipse.microprofile.openapi.models">OpenAPI</a> tags(java.util.List<<a href="../../../../../org/eclipse/microprofile/openapi/models/tags/Tag.html" title="interface in org.eclipse.microprofile.openapi.models.tags">Tag</a>> tags)</pre> |
| <div class="block">Sets this OpenAPI instance's tags property to the given tags.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>tags</code> - tags used by the specification with additional metadata</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current OpenAPI object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addTag-org.eclipse.microprofile.openapi.models.tags.Tag-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addTag</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html" title="interface in org.eclipse.microprofile.openapi.models">OpenAPI</a> addTag(<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">Adds the given tag to this OpenAPI instance's list of tags.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>tag</code> - a tag used by the specification with additional metadata</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current OpenAPI object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeTag-org.eclipse.microprofile.openapi.models.tags.Tag-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeTag</h4> |
| <pre>void removeTag(<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">Removes the given tag to this OpenAPI instance's list of tags.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>tag</code> - a tag used by the specification with additional metadata</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPaths--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPaths</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/Paths.html" title="interface in org.eclipse.microprofile.openapi.models">Paths</a> getPaths()</pre> |
| <div class="block">Returns the paths property from an OpenAPI instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the available paths and operations for the API</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPaths-org.eclipse.microprofile.openapi.models.Paths-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPaths</h4> |
| <pre>void setPaths(<a href="../../../../../org/eclipse/microprofile/openapi/models/Paths.html" title="interface in org.eclipse.microprofile.openapi.models">Paths</a> paths)</pre> |
| <div class="block">Sets this OpenAPI instance's paths property to the given paths.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>paths</code> - the available paths and operations for the API</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="paths-org.eclipse.microprofile.openapi.models.Paths-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>paths</h4> |
| <pre>default <a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html" title="interface in org.eclipse.microprofile.openapi.models">OpenAPI</a> paths(<a href="../../../../../org/eclipse/microprofile/openapi/models/Paths.html" title="interface in org.eclipse.microprofile.openapi.models">Paths</a> paths)</pre> |
| <div class="block">Sets this OpenAPI instance's paths property to the given paths.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>paths</code> - the available paths and operations for the API</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current OpenAPI object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getComponents--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getComponents</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html" title="interface in org.eclipse.microprofile.openapi.models">Components</a> getComponents()</pre> |
| <div class="block">Returns the components property from an OpenAPI instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>schemas used in the specification</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setComponents-org.eclipse.microprofile.openapi.models.Components-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setComponents</h4> |
| <pre>void setComponents(<a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html" title="interface in org.eclipse.microprofile.openapi.models">Components</a> components)</pre> |
| <div class="block">Sets this OpenAPI instance's components property to the given components.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>components</code> - a set of reusable objects used in the API specification</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="components-org.eclipse.microprofile.openapi.models.Components-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>components</h4> |
| <pre>default <a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html" title="interface in org.eclipse.microprofile.openapi.models">OpenAPI</a> components(<a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html" title="interface in org.eclipse.microprofile.openapi.models">Components</a> components)</pre> |
| <div class="block">Sets this OpenAPI instance's components property to the given components.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>components</code> - a set of reusable objects used in the API specification</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current OpenAPI object</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/models/ExternalDocumentation.html" title="interface in org.eclipse.microprofile.openapi.models"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/microprofile/openapi/models/OpenAPI.html" target="_top">Frames</a></li> |
| <li><a href="OpenAPI.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> |