| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>Components</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="Components"; |
| } |
| } |
| 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}; |
| 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>Prev Class</li> |
| <li><a href="../../../../../org/eclipse/microprofile/openapi/models/Constructible.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/Components.html" target="_top">Frames</a></li> |
| <li><a href="Components.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 Components" class="title">Interface Components</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></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Components</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></pre> |
| <div class="block">Components |
| <p> |
| Holds a set of reusable objects for different aspects of the API specification. All objects defined within this object will have no effect on the |
| API unless they are explicitly referenced from properties outside the components object. |
| <p> |
| All the fields are indexed by keys that must match the regular expression: <code>^[a-zA-Z0-9\.\-_]+$</code>. |
| <p> |
| Key Examples: |
| <ul> |
| <li>User</li> |
| <li>User_1</li> |
| <li>User_Name</li> |
| <li>user-name</li> |
| <li>my.org.User</li> |
| </ul></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#componentsObject"> OpenAPI Specification Components |
| 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></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/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/Components.html#addCallback-java.lang.String-org.eclipse.microprofile.openapi.models.callbacks.Callback-">addCallback</a></span>(java.lang.String key, |
| <a href="../../../../../org/eclipse/microprofile/openapi/models/callbacks/Callback.html" title="interface in org.eclipse.microprofile.openapi.models.callbacks">Callback</a> callback)</code> |
| <div class="block">Adds the given callback to this Components' map of callbacks with the given string as its key.</div> |
| </td> |
| </tr> |
| <tr id="i1" 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/Components.html#addExample-java.lang.String-org.eclipse.microprofile.openapi.models.examples.Example-">addExample</a></span>(java.lang.String key, |
| <a href="../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html" title="interface in org.eclipse.microprofile.openapi.models.examples">Example</a> example)</code> |
| <div class="block">Adds the given example to this Components' map of examples with the given string as its key.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <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/Components.html#addHeader-java.lang.String-org.eclipse.microprofile.openapi.models.headers.Header-">addHeader</a></span>(java.lang.String key, |
| <a href="../../../../../org/eclipse/microprofile/openapi/models/headers/Header.html" title="interface in org.eclipse.microprofile.openapi.models.headers">Header</a> header)</code> |
| <div class="block">Adds the given header to this Components' map of headers with the given string as its key.</div> |
| </td> |
| </tr> |
| <tr id="i3" 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/Components.html#addLink-java.lang.String-org.eclipse.microprofile.openapi.models.links.Link-">addLink</a></span>(java.lang.String key, |
| <a href="../../../../../org/eclipse/microprofile/openapi/models/links/Link.html" title="interface in org.eclipse.microprofile.openapi.models.links">Link</a> link)</code> |
| <div class="block">Adds the given link to this Components' map of links with the given string as its key.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <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/Components.html#addParameter-java.lang.String-org.eclipse.microprofile.openapi.models.parameters.Parameter-">addParameter</a></span>(java.lang.String key, |
| <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 Components' map of parameters with the given string as its key.</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/Components.html#addRequestBody-java.lang.String-org.eclipse.microprofile.openapi.models.parameters.RequestBody-">addRequestBody</a></span>(java.lang.String key, |
| <a href="../../../../../org/eclipse/microprofile/openapi/models/parameters/RequestBody.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">RequestBody</a> requestBody)</code> |
| <div class="block">Adds the given request body to this Components' map of request bodies with the given string as its key.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <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/Components.html#addResponse-java.lang.String-org.eclipse.microprofile.openapi.models.responses.APIResponse-">addResponse</a></span>(java.lang.String key, |
| <a href="../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html" title="interface in org.eclipse.microprofile.openapi.models.responses">APIResponse</a> response)</code> |
| <div class="block">Adds the given response to this Components' map of responses with the given string as its key.</div> |
| </td> |
| </tr> |
| <tr id="i7" 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/Components.html#addSchema-java.lang.String-org.eclipse.microprofile.openapi.models.media.Schema-">addSchema</a></span>(java.lang.String key, |
| <a href="../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> schema)</code> |
| <div class="block">Adds the given schema to this Components' list of schemas with the given string as its key.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <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/Components.html#addSecurityScheme-java.lang.String-org.eclipse.microprofile.openapi.models.security.SecurityScheme-">addSecurityScheme</a></span>(java.lang.String key, |
| <a href="../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityScheme</a> securityScheme)</code> |
| <div class="block">Adds the given security scheme to this Components' map of security schemes with the given string as its key.</div> |
| </td> |
| </tr> |
| <tr id="i9" 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/Components.html#callbacks-java.util.Map-">callbacks</a></span>(java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/callbacks/Callback.html" title="interface in org.eclipse.microprofile.openapi.models.callbacks">Callback</a>> callbacks)</code> |
| <div class="block">Sets this Components' callbacks property to the given Map containing keys and reusable callback objects.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <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/Components.html#examples-java.util.Map-">examples</a></span>(java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html" title="interface in org.eclipse.microprofile.openapi.models.examples">Example</a>> examples)</code> |
| <div class="block">Sets this Components' examples property to the given Map containing keys and reusable example objects.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/callbacks/Callback.html" title="interface in org.eclipse.microprofile.openapi.models.callbacks">Callback</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html#getCallbacks--">getCallbacks</a></span>()</code> |
| <div class="block">Returns the callbacks property from a Components instance.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html" title="interface in org.eclipse.microprofile.openapi.models.examples">Example</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html#getExamples--">getExamples</a></span>()</code> |
| <div class="block">Returns the examples property from a Components instance.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/headers/Header.html" title="interface in org.eclipse.microprofile.openapi.models.headers">Header</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html#getHeaders--">getHeaders</a></span>()</code> |
| <div class="block">Returns the headers property from a Components instance.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/links/Link.html" title="interface in org.eclipse.microprofile.openapi.models.links">Link</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html#getLinks--">getLinks</a></span>()</code> |
| <div class="block">Returns the links property from a Components instance.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,<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/Components.html#getParameters--">getParameters</a></span>()</code> |
| <div class="block">Returns the parameters property from a Components instance.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/parameters/RequestBody.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">RequestBody</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html#getRequestBodies--">getRequestBodies</a></span>()</code> |
| <div class="block">Returns the requestBodies property from a Components instance.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html" title="interface in org.eclipse.microprofile.openapi.models.responses">APIResponse</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html#getResponses--">getResponses</a></span>()</code> |
| <div class="block">Returns the responses property from a Components instance.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html#getSchemas--">getSchemas</a></span>()</code> |
| <div class="block">Returns the schemas property from a Components instance.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityScheme</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html#getSecuritySchemes--">getSecuritySchemes</a></span>()</code> |
| <div class="block">Returns the securitySchemes property from a Components instance.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <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/Components.html#headers-java.util.Map-">headers</a></span>(java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/headers/Header.html" title="interface in org.eclipse.microprofile.openapi.models.headers">Header</a>> headers)</code> |
| <div class="block">Sets this Components' headers property to the given Map containing keys and reusable header objects.</div> |
| </td> |
| </tr> |
| <tr id="i21" 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/Components.html#links-java.util.Map-">links</a></span>(java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/links/Link.html" title="interface in org.eclipse.microprofile.openapi.models.links">Link</a>> links)</code> |
| <div class="block">Sets this Components' links property to the given Map containing keys and reusable link objects.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <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/Components.html#parameters-java.util.Map-">parameters</a></span>(java.util.Map<java.lang.String,<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 Components' parameters property to the given Map containing keys and reusable parameter objects.</div> |
| </td> |
| </tr> |
| <tr id="i23" 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/Components.html#requestBodies-java.util.Map-">requestBodies</a></span>(java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/parameters/RequestBody.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">RequestBody</a>> requestBodies)</code> |
| <div class="block">Sets this Components' requestBodies property to the given Map containing keys and reusable request body objects.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <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/Components.html#responses-java.util.Map-">responses</a></span>(java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html" title="interface in org.eclipse.microprofile.openapi.models.responses">APIResponse</a>> responses)</code> |
| <div class="block">Sets this Components' responses property to the given Map containing keys and reusable response objects.</div> |
| </td> |
| </tr> |
| <tr id="i25" 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/Components.html#schemas-java.util.Map-">schemas</a></span>(java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>> schemas)</code> |
| <div class="block">Sets this Components' schemas property to the given Map containing keys and reusable schemas.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <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/Components.html#securitySchemes-java.util.Map-">securitySchemes</a></span>(java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityScheme</a>> securitySchemes)</code> |
| <div class="block">Sets this Components' securitySchemes property to the given Map containing keys and reusable security scheme objects.</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/Components.html#setCallbacks-java.util.Map-">setCallbacks</a></span>(java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/callbacks/Callback.html" title="interface in org.eclipse.microprofile.openapi.models.callbacks">Callback</a>> callbacks)</code> |
| <div class="block">Sets this Components' callbacks property to the given Map containing keys and reusable callback objects.</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/Components.html#setExamples-java.util.Map-">setExamples</a></span>(java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html" title="interface in org.eclipse.microprofile.openapi.models.examples">Example</a>> examples)</code> |
| <div class="block">Sets this Components' examples property to the given Map containing keys and reusable example objects.</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/Components.html#setHeaders-java.util.Map-">setHeaders</a></span>(java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/headers/Header.html" title="interface in org.eclipse.microprofile.openapi.models.headers">Header</a>> headers)</code> |
| <div class="block">Sets this Components' headers property to the given Map containing keys and reusable header objects.</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/Components.html#setLinks-java.util.Map-">setLinks</a></span>(java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/links/Link.html" title="interface in org.eclipse.microprofile.openapi.models.links">Link</a>> links)</code> |
| <div class="block">Sets this Components' links property to the given Map containing keys and reusable link objects.</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/Components.html#setParameters-java.util.Map-">setParameters</a></span>(java.util.Map<java.lang.String,<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 Components' parameters property to the given Map containing keys and reusable parameter objects.</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/Components.html#setRequestBodies-java.util.Map-">setRequestBodies</a></span>(java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/parameters/RequestBody.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">RequestBody</a>> requestBodies)</code> |
| <div class="block">Sets this Components' requestBodies property to the given Map containing keys and reusable request body objects.</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/Components.html#setResponses-java.util.Map-">setResponses</a></span>(java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html" title="interface in org.eclipse.microprofile.openapi.models.responses">APIResponse</a>> responses)</code> |
| <div class="block">Sets this Components' responses property to the given Map containing keys and reusable response objects.</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/Components.html#setSchemas-java.util.Map-">setSchemas</a></span>(java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>> schemas)</code> |
| <div class="block">Sets this Components' schemas property to the given Map containing keys and reusable schema objects.</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/Components.html#setSecuritySchemes-java.util.Map-">setSecuritySchemes</a></span>(java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityScheme</a>> securitySchemes)</code> |
| <div class="block">Sets this Components' securitySchemes property to the given Map containing keys and reusable security scheme objects.</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> |
| </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="getSchemas--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchemas</h4> |
| <pre>java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>> getSchemas()</pre> |
| <div class="block">Returns the schemas property from a Components instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Map containing the keys and the reusable schemas for this OpenAPI document</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSchemas-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSchemas</h4> |
| <pre>void setSchemas(java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>> schemas)</pre> |
| <div class="block">Sets this Components' schemas property to the given Map containing keys and reusable schema objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>schemas</code> - a Map containing keys and reusable schema objects</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="schemas-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>schemas</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html" title="interface in org.eclipse.microprofile.openapi.models">Components</a> schemas(java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>> schemas)</pre> |
| <div class="block">Sets this Components' schemas property to the given Map containing keys and reusable schemas.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>schemas</code> - a Map containing keys and reusable schemas</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Components object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addSchema-java.lang.String-org.eclipse.microprofile.openapi.models.media.Schema-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addSchema</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html" title="interface in org.eclipse.microprofile.openapi.models">Components</a> addSchema(java.lang.String key, |
| <a href="../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> schema)</pre> |
| <div class="block">Adds the given schema to this Components' list of schemas with the given string as its key.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - a key conforming to the format required for this object</dd> |
| <dd><code>schema</code> - a reusable schema object</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Components object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getResponses--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResponses</h4> |
| <pre>java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html" title="interface in org.eclipse.microprofile.openapi.models.responses">APIResponse</a>> getResponses()</pre> |
| <div class="block">Returns the responses property from a Components instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Map containing the keys and the reusable responses from API operations for this OpenAPI document</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setResponses-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setResponses</h4> |
| <pre>void setResponses(java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html" title="interface in org.eclipse.microprofile.openapi.models.responses">APIResponse</a>> responses)</pre> |
| <div class="block">Sets this Components' responses property to the given Map containing keys and reusable response objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>responses</code> - a Map containing keys and reusable response objects</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="responses-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>responses</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html" title="interface in org.eclipse.microprofile.openapi.models">Components</a> responses(java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html" title="interface in org.eclipse.microprofile.openapi.models.responses">APIResponse</a>> responses)</pre> |
| <div class="block">Sets this Components' responses property to the given Map containing keys and reusable response objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>responses</code> - a Map containing keys and reusable response objects</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Components object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addResponse-java.lang.String-org.eclipse.microprofile.openapi.models.responses.APIResponse-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addResponse</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html" title="interface in org.eclipse.microprofile.openapi.models">Components</a> addResponse(java.lang.String key, |
| <a href="../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html" title="interface in org.eclipse.microprofile.openapi.models.responses">APIResponse</a> response)</pre> |
| <div class="block">Adds the given response to this Components' map of responses with the given string as its key.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - a key conforming to the format required for this object</dd> |
| <dd><code>response</code> - a reusable response object</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Components object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getParameters--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParameters</h4> |
| <pre>java.util.Map<java.lang.String,<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 a Components instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Map containing the keys and the reusable parameters of API operations for this OpenAPI document</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setParameters-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setParameters</h4> |
| <pre>void setParameters(java.util.Map<java.lang.String,<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 Components' parameters property to the given Map containing keys and reusable parameter objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parameters</code> - a Map containing keys and reusable parameter objects</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="parameters-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parameters</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html" title="interface in org.eclipse.microprofile.openapi.models">Components</a> parameters(java.util.Map<java.lang.String,<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 Components' parameters property to the given Map containing keys and reusable parameter objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parameters</code> - a Map containing keys and reusable parameter objects</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Components object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addParameter-java.lang.String-org.eclipse.microprofile.openapi.models.parameters.Parameter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addParameter</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html" title="interface in org.eclipse.microprofile.openapi.models">Components</a> addParameter(java.lang.String key, |
| <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 Components' map of parameters with the given string as its key.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - a key conforming to the format required for this object</dd> |
| <dd><code>parameter</code> - a reusable parameter object</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Components object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getExamples--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExamples</h4> |
| <pre>java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html" title="interface in org.eclipse.microprofile.openapi.models.examples">Example</a>> getExamples()</pre> |
| <div class="block">Returns the examples property from a Components instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Map containing the keys and the reusable examples for this OpenAPI document</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setExamples-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExamples</h4> |
| <pre>void setExamples(java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html" title="interface in org.eclipse.microprofile.openapi.models.examples">Example</a>> examples)</pre> |
| <div class="block">Sets this Components' examples property to the given Map containing keys and reusable example objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>examples</code> - a Map containing keys and reusable example objects</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="examples-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>examples</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html" title="interface in org.eclipse.microprofile.openapi.models">Components</a> examples(java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html" title="interface in org.eclipse.microprofile.openapi.models.examples">Example</a>> examples)</pre> |
| <div class="block">Sets this Components' examples property to the given Map containing keys and reusable example objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>examples</code> - a Map containing keys and reusable example objects</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Components object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addExample-java.lang.String-org.eclipse.microprofile.openapi.models.examples.Example-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addExample</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html" title="interface in org.eclipse.microprofile.openapi.models">Components</a> addExample(java.lang.String key, |
| <a href="../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html" title="interface in org.eclipse.microprofile.openapi.models.examples">Example</a> example)</pre> |
| <div class="block">Adds the given example to this Components' map of examples with the given string as its key.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - a key conforming to the format required for this object</dd> |
| <dd><code>example</code> - a reusable example object</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Components object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRequestBodies--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRequestBodies</h4> |
| <pre>java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/parameters/RequestBody.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">RequestBody</a>> getRequestBodies()</pre> |
| <div class="block">Returns the requestBodies property from a Components instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Map containing the keys and the reusable request bodies for this OpenAPI document</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRequestBodies-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRequestBodies</h4> |
| <pre>void setRequestBodies(java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/parameters/RequestBody.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">RequestBody</a>> requestBodies)</pre> |
| <div class="block">Sets this Components' requestBodies property to the given Map containing keys and reusable request body objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>requestBodies</code> - a Map containing the keys and reusable request body objects</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="requestBodies-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>requestBodies</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html" title="interface in org.eclipse.microprofile.openapi.models">Components</a> requestBodies(java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/parameters/RequestBody.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">RequestBody</a>> requestBodies)</pre> |
| <div class="block">Sets this Components' requestBodies property to the given Map containing keys and reusable request body objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>requestBodies</code> - a Map containing the keys and reusable request body objects</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Components object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addRequestBody-java.lang.String-org.eclipse.microprofile.openapi.models.parameters.RequestBody-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addRequestBody</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html" title="interface in org.eclipse.microprofile.openapi.models">Components</a> addRequestBody(java.lang.String key, |
| <a href="../../../../../org/eclipse/microprofile/openapi/models/parameters/RequestBody.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">RequestBody</a> requestBody)</pre> |
| <div class="block">Adds the given request body to this Components' map of request bodies with the given string as its key.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - a key conforming to the format required for this object</dd> |
| <dd><code>requestBody</code> - a reusable request body object</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Components object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getHeaders--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHeaders</h4> |
| <pre>java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/headers/Header.html" title="interface in org.eclipse.microprofile.openapi.models.headers">Header</a>> getHeaders()</pre> |
| <div class="block">Returns the headers property from a Components instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Map containing the keys and the reusable headers for this OpenAPI document</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setHeaders-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHeaders</h4> |
| <pre>void setHeaders(java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/headers/Header.html" title="interface in org.eclipse.microprofile.openapi.models.headers">Header</a>> headers)</pre> |
| <div class="block">Sets this Components' headers property to the given Map containing keys and reusable header objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>headers</code> - a Map containing the keys and reusable header objects</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="headers-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>headers</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html" title="interface in org.eclipse.microprofile.openapi.models">Components</a> headers(java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/headers/Header.html" title="interface in org.eclipse.microprofile.openapi.models.headers">Header</a>> headers)</pre> |
| <div class="block">Sets this Components' headers property to the given Map containing keys and reusable header objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>headers</code> - a Map containing the keys and reusable header objects</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Components object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addHeader-java.lang.String-org.eclipse.microprofile.openapi.models.headers.Header-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addHeader</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html" title="interface in org.eclipse.microprofile.openapi.models">Components</a> addHeader(java.lang.String key, |
| <a href="../../../../../org/eclipse/microprofile/openapi/models/headers/Header.html" title="interface in org.eclipse.microprofile.openapi.models.headers">Header</a> header)</pre> |
| <div class="block">Adds the given header to this Components' map of headers with the given string as its key.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - a key conforming to the format required for this object</dd> |
| <dd><code>header</code> - a reusable header object</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Components object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSecuritySchemes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSecuritySchemes</h4> |
| <pre>java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityScheme</a>> getSecuritySchemes()</pre> |
| <div class="block">Returns the securitySchemes property from a Components instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Map containing the keys and the reusable security schemes for this OpenAPI document</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSecuritySchemes-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSecuritySchemes</h4> |
| <pre>void setSecuritySchemes(java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityScheme</a>> securitySchemes)</pre> |
| <div class="block">Sets this Components' securitySchemes property to the given Map containing keys and reusable security scheme objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>securitySchemes</code> - a Map containing the keys and reusable security scheme objects</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="securitySchemes-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>securitySchemes</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html" title="interface in org.eclipse.microprofile.openapi.models">Components</a> securitySchemes(java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityScheme</a>> securitySchemes)</pre> |
| <div class="block">Sets this Components' securitySchemes property to the given Map containing keys and reusable security scheme objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>securitySchemes</code> - a Map containing the keys and reusable security scheme objects</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Components object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addSecurityScheme-java.lang.String-org.eclipse.microprofile.openapi.models.security.SecurityScheme-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addSecurityScheme</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html" title="interface in org.eclipse.microprofile.openapi.models">Components</a> addSecurityScheme(java.lang.String key, |
| <a href="../../../../../org/eclipse/microprofile/openapi/models/security/SecurityScheme.html" title="interface in org.eclipse.microprofile.openapi.models.security">SecurityScheme</a> securityScheme)</pre> |
| <div class="block">Adds the given security scheme to this Components' map of security schemes with the given string as its key.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - a key conforming to the format required for this object</dd> |
| <dd><code>securityScheme</code> - a reusable security scheme object</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Components object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLinks--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLinks</h4> |
| <pre>java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/links/Link.html" title="interface in org.eclipse.microprofile.openapi.models.links">Link</a>> getLinks()</pre> |
| <div class="block">Returns the links property from a Components instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Map containing the keys and the reusable links for this OpenAPI document</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLinks-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLinks</h4> |
| <pre>void setLinks(java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/links/Link.html" title="interface in org.eclipse.microprofile.openapi.models.links">Link</a>> links)</pre> |
| <div class="block">Sets this Components' links property to the given Map containing keys and reusable link objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>links</code> - a Map containing the keys and reusable link objects</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="links-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>links</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html" title="interface in org.eclipse.microprofile.openapi.models">Components</a> links(java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/links/Link.html" title="interface in org.eclipse.microprofile.openapi.models.links">Link</a>> links)</pre> |
| <div class="block">Sets this Components' links property to the given Map containing keys and reusable link objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>links</code> - a Map containing the keys and reusable link objects</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Components object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addLink-java.lang.String-org.eclipse.microprofile.openapi.models.links.Link-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addLink</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html" title="interface in org.eclipse.microprofile.openapi.models">Components</a> addLink(java.lang.String key, |
| <a href="../../../../../org/eclipse/microprofile/openapi/models/links/Link.html" title="interface in org.eclipse.microprofile.openapi.models.links">Link</a> link)</pre> |
| <div class="block">Adds the given link to this Components' map of links with the given string as its key.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - a key conforming to the format required for this object</dd> |
| <dd><code>link</code> - a reusable link object</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Components object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCallbacks--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCallbacks</h4> |
| <pre>java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/callbacks/Callback.html" title="interface in org.eclipse.microprofile.openapi.models.callbacks">Callback</a>> getCallbacks()</pre> |
| <div class="block">Returns the callbacks property from a Components instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Map containing the keys and the reusable callbacks for this OpenAPI document</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCallbacks-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCallbacks</h4> |
| <pre>void setCallbacks(java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/callbacks/Callback.html" title="interface in org.eclipse.microprofile.openapi.models.callbacks">Callback</a>> callbacks)</pre> |
| <div class="block">Sets this Components' callbacks property to the given Map containing keys and reusable callback objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>callbacks</code> - a Map containing the keys and reusable callback objects</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="callbacks-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>callbacks</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html" title="interface in org.eclipse.microprofile.openapi.models">Components</a> callbacks(java.util.Map<java.lang.String,<a href="../../../../../org/eclipse/microprofile/openapi/models/callbacks/Callback.html" title="interface in org.eclipse.microprofile.openapi.models.callbacks">Callback</a>> callbacks)</pre> |
| <div class="block">Sets this Components' callbacks property to the given Map containing keys and reusable callback objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>callbacks</code> - a Map containing the keys and reusable callback objects</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Components object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addCallback-java.lang.String-org.eclipse.microprofile.openapi.models.callbacks.Callback-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>addCallback</h4> |
| <pre><a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html" title="interface in org.eclipse.microprofile.openapi.models">Components</a> addCallback(java.lang.String key, |
| <a href="../../../../../org/eclipse/microprofile/openapi/models/callbacks/Callback.html" title="interface in org.eclipse.microprofile.openapi.models.callbacks">Callback</a> callback)</pre> |
| <div class="block">Adds the given callback to this Components' map of callbacks with the given string as its key.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - a key conforming to the format required for this object</dd> |
| <dd><code>callback</code> - a reusable callback object</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Components 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>Prev Class</li> |
| <li><a href="../../../../../org/eclipse/microprofile/openapi/models/Constructible.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/Components.html" target="_top">Frames</a></li> |
| <li><a href="Components.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> |