| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>PathItem</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="PathItem"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6,"i36":6,"i37":6,"i38":6,"i39":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/Operation.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/PathItem.HttpMethod.html" title="enum 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/PathItem.html" target="_top">Frames</a></li> |
| <li><a href="PathItem.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><a href="#nested.class.summary">Nested</a> | </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 PathItem" class="title">Interface PathItem</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/Reference.html" title="interface in org.eclipse.microprofile.openapi.models">Reference</a><<a href="../../../../../org/eclipse/microprofile/openapi/models/PathItem.html" title="interface in org.eclipse.microprofile.openapi.models">PathItem</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">PathItem</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/Reference.html" title="interface in org.eclipse.microprofile.openapi.models">Reference</a><<a href="../../../../../org/eclipse/microprofile/openapi/models/PathItem.html" title="interface in org.eclipse.microprofile.openapi.models">PathItem</a>></pre> |
| <div class="block">PathItem |
| <p> |
| Describes the operations available on a single path. A Path Item MAY be empty, due to |
| <a href= "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#security-filtering">security constraints</a>. In that case the |
| path itself is still exposed to the documentation viewer but you will not know which operations and parameters are available. |
| <p></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#pathItemObject"> OpenAPI Specification Path Item |
| Object</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/PathItem.HttpMethod.html" title="enum in org.eclipse.microprofile.openapi.models">PathItem.HttpMethod</a></span></code> |
| <div class="block">All of the possible types of HTTP operations for this path</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== 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></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/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/models/PathItem.html#addParameter-org.eclipse.microprofile.openapi.models.parameters.Parameter-">addParameter</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">Adds the given parameter to this PathItem's list of parameters.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><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/models/PathItem.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 PathItem's list of servers.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><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/models/PathItem.html#DELETE-org.eclipse.microprofile.openapi.models.Operation-">DELETE</a></span>(<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> delete)</code> |
| <div class="block">Sets this PathItem's delete property to the given operation.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><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/models/PathItem.html#description-java.lang.String-">description</a></span>(java.lang.String description)</code> |
| <div class="block">Sets this PathItem's description property to the given string.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><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/models/PathItem.html#GET-org.eclipse.microprofile.openapi.models.Operation-">GET</a></span>(<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> get)</code> |
| <div class="block">Sets this PathItem's get property to the given operation.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><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/models/PathItem.html#getDELETE--">getDELETE</a></span>()</code> |
| <div class="block">Returns the delete property from a PathItem instance.</div> |
| </td> |
| </tr> |
| <tr id="i6" 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/PathItem.html#getDescription--">getDescription</a></span>()</code> |
| <div class="block">Returns the description property from a PathItem instance.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><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/models/PathItem.html#getGET--">getGET</a></span>()</code> |
| <div class="block">Returns the get property from a PathItem instance.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><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/models/PathItem.html#getHEAD--">getHEAD</a></span>()</code> |
| <div class="block">Returns the head property from a PathItem instance.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><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/models/PathItem.html#getOPTIONS--">getOPTIONS</a></span>()</code> |
| <div class="block">Returns the options property from a PathItem instance.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>java.util.List<<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/models/PathItem.html#getParameters--">getParameters</a></span>()</code> |
| <div class="block">Returns the parameters property from this PathItem instance.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><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/models/PathItem.html#getPATCH--">getPATCH</a></span>()</code> |
| <div class="block">Returns the patch property from a PathItem instance.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><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/models/PathItem.html#getPOST--">getPOST</a></span>()</code> |
| <div class="block">Returns the post property from a PathItem instance.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><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/models/PathItem.html#getPUT--">getPUT</a></span>()</code> |
| <div class="block">Returns the put property from a PathItem instance.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <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/PathItem.html#getServers--">getServers</a></span>()</code> |
| <div class="block">Returns the servers property from a PathItem instance.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/PathItem.html#getSummary--">getSummary</a></span>()</code> |
| <div class="block">Returns the summary property from a PathItem instance.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><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/models/PathItem.html#getTRACE--">getTRACE</a></span>()</code> |
| <div class="block">Returns the trace property from a PathItem instance.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><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/models/PathItem.html#HEAD-org.eclipse.microprofile.openapi.models.Operation-">HEAD</a></span>(<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> head)</code> |
| <div class="block">Sets this PathItem's head property to the given operation.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><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/models/PathItem.html#OPTIONS-org.eclipse.microprofile.openapi.models.Operation-">OPTIONS</a></span>(<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> options)</code> |
| <div class="block">Sets this PathItem's options property to the given operation.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><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/models/PathItem.html#parameters-java.util.List-">parameters</a></span>(java.util.List<<a href="../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a>> parameters)</code> |
| <div class="block">Sets this PathItem's parameters property to the given list.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><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/models/PathItem.html#PATCH-org.eclipse.microprofile.openapi.models.Operation-">PATCH</a></span>(<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> patch)</code> |
| <div class="block">Sets this PathItem's patch property to the given operation.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><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/models/PathItem.html#POST-org.eclipse.microprofile.openapi.models.Operation-">POST</a></span>(<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> post)</code> |
| <div class="block">Sets this PathItem's post property to the given operation.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><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/models/PathItem.html#PUT-org.eclipse.microprofile.openapi.models.Operation-">PUT</a></span>(<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> put)</code> |
| <div class="block">Sets this PathItem's put property to the given operation.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<<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/models/PathItem.html#readOperations--">readOperations</a></span>()</code> |
| <div class="block">Returns a list of all the operations for this path item.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>java.util.Map<<a href="../../../../../org/eclipse/microprofile/openapi/models/PathItem.HttpMethod.html" title="enum in org.eclipse.microprofile.openapi.models">PathItem.HttpMethod</a>,<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/models/PathItem.html#readOperationsMap--">readOperationsMap</a></span>()</code> |
| <div class="block">Returns a map with all the operations for this path where the keys are HttpMethods.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><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/models/PathItem.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 PathItem's servers property to the given list.</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/PathItem.html#setDELETE-org.eclipse.microprofile.openapi.models.Operation-">setDELETE</a></span>(<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> delete)</code> |
| <div class="block">Sets this PathItem's delete property to the given operation.</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/PathItem.html#setDescription-java.lang.String-">setDescription</a></span>(java.lang.String description)</code> |
| <div class="block">Sets this PathItem's description property to the given string.</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/PathItem.html#setGET-org.eclipse.microprofile.openapi.models.Operation-">setGET</a></span>(<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> get)</code> |
| <div class="block">Sets this PathItem's get property to the given operation.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/PathItem.html#setHEAD-org.eclipse.microprofile.openapi.models.Operation-">setHEAD</a></span>(<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> head)</code> |
| <div class="block">Sets this PathItem's head property to the given operation.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/PathItem.html#setOPTIONS-org.eclipse.microprofile.openapi.models.Operation-">setOPTIONS</a></span>(<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> options)</code> |
| <div class="block">Sets this PathItem's options property to the given operation.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/PathItem.html#setParameters-java.util.List-">setParameters</a></span>(java.util.List<<a href="../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a>> parameters)</code> |
| <div class="block">Sets this PathItem's parameters property to the given list.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/PathItem.html#setPATCH-org.eclipse.microprofile.openapi.models.Operation-">setPATCH</a></span>(<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> patch)</code> |
| <div class="block">Sets this PathItem's patch property to the given operation.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/PathItem.html#setPOST-org.eclipse.microprofile.openapi.models.Operation-">setPOST</a></span>(<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> post)</code> |
| <div class="block">Sets this PathItem's post property to the given operation.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/PathItem.html#setPUT-org.eclipse.microprofile.openapi.models.Operation-">setPUT</a></span>(<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> put)</code> |
| <div class="block">Sets this PathItem's put property to the given operation.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/PathItem.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 PathItem's servers property to the given list.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/PathItem.html#setSummary-java.lang.String-">setSummary</a></span>(java.lang.String summary)</code> |
| <div class="block">Sets this PathItem's summary property to the given string.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/PathItem.html#setTRACE-org.eclipse.microprofile.openapi.models.Operation-">setTRACE</a></span>(<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> trace)</code> |
| <div class="block">Sets this PathItem's trace property to the given operation.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code><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/models/PathItem.html#summary-java.lang.String-">summary</a></span>(java.lang.String summary)</code> |
| <div class="block">Sets this PathItem's summary property to the given string.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code><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/models/PathItem.html#TRACE-org.eclipse.microprofile.openapi.models.Operation-">TRACE</a></span>(<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> trace)</code> |
| <div class="block">Sets this PathItem's trace property to the given operation.</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#getExtensions--">getExtensions</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/Extensible.html#setExtensions-java.util.Map-">setExtensions</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.microprofile.openapi.models.Reference"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.microprofile.openapi.models.<a href="../../../../../org/eclipse/microprofile/openapi/models/Reference.html" title="interface in org.eclipse.microprofile.openapi.models">Reference</a></h3> |
| <code><a href="../../../../../org/eclipse/microprofile/openapi/models/Reference.html#getRef--">getRef</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/Reference.html#ref-java.lang.String-">ref</a>, <a href="../../../../../org/eclipse/microprofile/openapi/models/Reference.html#setRef-java.lang.String-">setRef</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="getSummary--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSummary</h4> |
| <pre>java.lang.String getSummary()</pre> |
| <div class="block">Returns the summary property from a PathItem instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a short summary of what the path item represents</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSummary-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSummary</h4> |
| <pre>void setSummary(java.lang.String summary)</pre> |
| <div class="block">Sets this PathItem's summary property to the given string.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>summary</code> - short summary of what the path item represents</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="summary-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>summary</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/PathItem.html" title="interface in org.eclipse.microprofile.openapi.models">PathItem</a> summary(java.lang.String summary)</pre> |
| <div class="block">Sets this PathItem's summary property to the given string.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>summary</code> - short summary of what the path item represents</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current PathItem instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDescription--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDescription</h4> |
| <pre>java.lang.String getDescription()</pre> |
| <div class="block">Returns the description property from a PathItem instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a detailed description of what the path item represents</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDescription-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDescription</h4> |
| <pre>void setDescription(java.lang.String description)</pre> |
| <div class="block">Sets this PathItem's description property to the given string.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>description</code> - detailed description of what the path item represents</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="description-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>description</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/PathItem.html" title="interface in org.eclipse.microprofile.openapi.models">PathItem</a> description(java.lang.String description)</pre> |
| <div class="block">Sets this PathItem's description property to the given string.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>description</code> - detailed description of what the path item represents</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current PathItem instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getGET--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGET</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> getGET()</pre> |
| <div class="block">Returns the get property from a PathItem instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>definition of a GET operation on this path</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setGET-org.eclipse.microprofile.openapi.models.Operation-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setGET</h4> |
| <pre>void setGET(<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> get)</pre> |
| <div class="block">Sets this PathItem's get property to the given operation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>get</code> - definition of a GET operation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="GET-org.eclipse.microprofile.openapi.models.Operation-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>GET</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/PathItem.html" title="interface in org.eclipse.microprofile.openapi.models">PathItem</a> GET(<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> get)</pre> |
| <div class="block">Sets this PathItem's get property to the given operation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>get</code> - definition of a GET operation</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current PathItem instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPUT--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPUT</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> getPUT()</pre> |
| <div class="block">Returns the put property from a PathItem instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>definition of a PUT operation on this path</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPUT-org.eclipse.microprofile.openapi.models.Operation-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPUT</h4> |
| <pre>void setPUT(<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> put)</pre> |
| <div class="block">Sets this PathItem's put property to the given operation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>put</code> - definition of a PUT operation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="PUT-org.eclipse.microprofile.openapi.models.Operation-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PUT</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/PathItem.html" title="interface in org.eclipse.microprofile.openapi.models">PathItem</a> PUT(<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> put)</pre> |
| <div class="block">Sets this PathItem's put property to the given operation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>put</code> - definition of a PUT operation</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current PathItem instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPOST--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPOST</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> getPOST()</pre> |
| <div class="block">Returns the post property from a PathItem instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>definition of a POST operation on this path</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPOST-org.eclipse.microprofile.openapi.models.Operation-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPOST</h4> |
| <pre>void setPOST(<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> post)</pre> |
| <div class="block">Sets this PathItem's post property to the given operation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>post</code> - definition of a PUT operation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="POST-org.eclipse.microprofile.openapi.models.Operation-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>POST</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/PathItem.html" title="interface in org.eclipse.microprofile.openapi.models">PathItem</a> POST(<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> post)</pre> |
| <div class="block">Sets this PathItem's post property to the given operation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>post</code> - definition of a PUT operation</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current PathItem instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDELETE--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDELETE</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> getDELETE()</pre> |
| <div class="block">Returns the delete property from a PathItem instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>definition of a DELETE operation on this path</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDELETE-org.eclipse.microprofile.openapi.models.Operation-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDELETE</h4> |
| <pre>void setDELETE(<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> delete)</pre> |
| <div class="block">Sets this PathItem's delete property to the given operation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>delete</code> - definition of a DELETE operation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DELETE-org.eclipse.microprofile.openapi.models.Operation-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DELETE</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/PathItem.html" title="interface in org.eclipse.microprofile.openapi.models">PathItem</a> DELETE(<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> delete)</pre> |
| <div class="block">Sets this PathItem's delete property to the given operation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>delete</code> - definition of a DELETE operation</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current PathItem instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOPTIONS--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOPTIONS</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> getOPTIONS()</pre> |
| <div class="block">Returns the options property from a PathItem instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>definition of an OPTIONS operation on this path</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setOPTIONS-org.eclipse.microprofile.openapi.models.Operation-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOPTIONS</h4> |
| <pre>void setOPTIONS(<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> options)</pre> |
| <div class="block">Sets this PathItem's options property to the given operation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>options</code> - definition of an OPTIONS operation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="OPTIONS-org.eclipse.microprofile.openapi.models.Operation-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>OPTIONS</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/PathItem.html" title="interface in org.eclipse.microprofile.openapi.models">PathItem</a> OPTIONS(<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> options)</pre> |
| <div class="block">Sets this PathItem's options property to the given operation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>options</code> - definition of an OPTIONS operation</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current PathItem instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getHEAD--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHEAD</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> getHEAD()</pre> |
| <div class="block">Returns the head property from a PathItem instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>definition of a HEAD operation on this path</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setHEAD-org.eclipse.microprofile.openapi.models.Operation-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHEAD</h4> |
| <pre>void setHEAD(<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> head)</pre> |
| <div class="block">Sets this PathItem's head property to the given operation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>head</code> - definition of a HEAD operation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="HEAD-org.eclipse.microprofile.openapi.models.Operation-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HEAD</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/PathItem.html" title="interface in org.eclipse.microprofile.openapi.models">PathItem</a> HEAD(<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> head)</pre> |
| <div class="block">Sets this PathItem's head property to the given operation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>head</code> - definition of a HEAD operation</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current PathItem instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPATCH--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPATCH</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> getPATCH()</pre> |
| <div class="block">Returns the patch property from a PathItem instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>definition of a PATCH operation on this path</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPATCH-org.eclipse.microprofile.openapi.models.Operation-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPATCH</h4> |
| <pre>void setPATCH(<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> patch)</pre> |
| <div class="block">Sets this PathItem's patch property to the given operation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>patch</code> - definition of a PATCH operation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="PATCH-org.eclipse.microprofile.openapi.models.Operation-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PATCH</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/PathItem.html" title="interface in org.eclipse.microprofile.openapi.models">PathItem</a> PATCH(<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> patch)</pre> |
| <div class="block">Sets this PathItem's patch property to the given operation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>patch</code> - definition of a PATCH operation</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current PathItem instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTRACE--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTRACE</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> getTRACE()</pre> |
| <div class="block">Returns the trace property from a PathItem instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>definition of a TRACE operation on this path</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setTRACE-org.eclipse.microprofile.openapi.models.Operation-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTRACE</h4> |
| <pre>void setTRACE(<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> trace)</pre> |
| <div class="block">Sets this PathItem's trace property to the given operation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>trace</code> - definition of a TRACE operation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="TRACE-org.eclipse.microprofile.openapi.models.Operation-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TRACE</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/PathItem.html" title="interface in org.eclipse.microprofile.openapi.models">PathItem</a> TRACE(<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a> trace)</pre> |
| <div class="block">Sets this PathItem's trace property to the given operation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>trace</code> - definition of a TRACE operation</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current PathItem instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readOperations--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readOperations</h4> |
| <pre>java.util.List<<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a>> readOperations()</pre> |
| <div class="block">Returns a list of all the operations for this path item.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a list of all the operations for this path item</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readOperationsMap--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readOperationsMap</h4> |
| <pre>java.util.Map<<a href="../../../../../org/eclipse/microprofile/openapi/models/PathItem.HttpMethod.html" title="enum in org.eclipse.microprofile.openapi.models">PathItem.HttpMethod</a>,<a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a>> readOperationsMap()</pre> |
| <div class="block">Returns a map with all the operations for this path where the keys are HttpMethods.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a map with all the operations for this path where the keys are HttpMethods</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 property from a PathItem instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a list of all the servers defined in this path item</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 PathItem's servers property to the given list.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>servers</code> - a list of the servers to service operations in this path item</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="servers-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>servers</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/PathItem.html" title="interface in org.eclipse.microprofile.openapi.models">PathItem</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 PathItem's servers property to the given list.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>servers</code> - a list of the servers to service operations in this path item</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current PathItem instance</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/PathItem.html" title="interface in org.eclipse.microprofile.openapi.models">PathItem</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 PathItem's list of servers.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>server</code> - a server to service operations in this path item</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current PathItem instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getParameters--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParameters</h4> |
| <pre>java.util.List<<a href="../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a>> getParameters()</pre> |
| <div class="block">Returns the parameters property from this PathItem instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a list of parameters that are applicable to all the operations described under this path</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setParameters-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setParameters</h4> |
| <pre>void setParameters(java.util.List<<a href="../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a>> parameters)</pre> |
| <div class="block">Sets this PathItem's parameters property to the given list.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parameters</code> - a list of parameters that are applicable to all the operations described under this path</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="parameters-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parameters</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/PathItem.html" title="interface in org.eclipse.microprofile.openapi.models">PathItem</a> parameters(java.util.List<<a href="../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a>> parameters)</pre> |
| <div class="block">Sets this PathItem's parameters property to the given list.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parameters</code> - a list of parameters that are applicable to all the operations described under this path</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current PathItem instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addParameter-org.eclipse.microprofile.openapi.models.parameters.Parameter-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>addParameter</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/PathItem.html" title="interface in org.eclipse.microprofile.openapi.models">PathItem</a> addParameter(<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">Adds the given parameter to this PathItem's list of parameters.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parameter</code> - a parameter that is applicable to all the operations described under this path</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current PathItem instance</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/Operation.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/PathItem.HttpMethod.html" title="enum 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/PathItem.html" target="_top">Frames</a></li> |
| <li><a href="PathItem.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><a href="#nested.class.summary">Nested</a> | </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> |
