| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>CallbackOperation</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="CallbackOperation"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </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/annotations/callbacks/Callback.html" title="annotation in org.eclipse.microprofile.openapi.annotations.callbacks"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/callbacks/Callbacks.html" title="annotation in org.eclipse.microprofile.openapi.annotations.callbacks"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/eclipse/microprofile/openapi/annotations/callbacks/CallbackOperation.html" target="_top">Frames</a></li> |
| <li><a href="CallbackOperation.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>Field | </li> |
| <li>Required | </li> |
| <li><a href="#annotation.type.optional.element.summary">Optional</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#annotation.type.element.detail">Element</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.annotations.callbacks</div> |
| <h2 title="Annotation Type CallbackOperation" class="title">Annotation Type CallbackOperation</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>@Target(value={}) |
| @Retention(value=RUNTIME) |
| @Inherited |
| public @interface <span class="memberNameLabel">CallbackOperation</span></pre> |
| <div class="block">Describes a single API callback operation.</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#operationObject">OpenAPI Specification Operation |
| Object</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="annotation.type.optional.element.summary"> |
| <!-- --> |
| </a> |
| <h3>Optional Element Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> |
| <caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Optional Element and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/callbacks/CallbackOperation.html#description--">description</a></span></code> |
| <div class="block">A verbose description of the callback operation behavior.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/extensions/Extension.html" title="annotation in org.eclipse.microprofile.openapi.annotations.extensions">Extension</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/callbacks/CallbackOperation.html#extensions--">extensions</a></span></code> |
| <div class="block">The list of optional extensions.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/ExternalDocumentation.html" title="annotation in org.eclipse.microprofile.openapi.annotations">ExternalDocumentation</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/callbacks/CallbackOperation.html#externalDocs--">externalDocs</a></span></code> |
| <div class="block">Additional external documentation for this callback operation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/callbacks/CallbackOperation.html#method--">method</a></span></code> |
| <div class="block">The HTTP method for this callback operation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/parameters/Parameter.html" title="annotation in org.eclipse.microprofile.openapi.annotations.parameters">Parameter</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/callbacks/CallbackOperation.html#parameters--">parameters</a></span></code> |
| <div class="block">An array of parameters applicable for this callback operation, |
| which will be added to any automatically detected parameters in the method itself.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/parameters/RequestBody.html" title="annotation in org.eclipse.microprofile.openapi.annotations.parameters">RequestBody</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/callbacks/CallbackOperation.html#requestBody--">requestBody</a></span></code> |
| <div class="block">The request body applicable for this callback operation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/responses/APIResponse.html" title="annotation in org.eclipse.microprofile.openapi.annotations.responses">APIResponse</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/callbacks/CallbackOperation.html#responses--">responses</a></span></code> |
| <div class="block">This is a REQUIRED property of an callback operation instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/security/SecurityRequirement.html" title="annotation in org.eclipse.microprofile.openapi.annotations.security">SecurityRequirement</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/callbacks/CallbackOperation.html#security--">security</a></span></code> |
| <div class="block">A declaration of which security mechanisms can be used for this callback operation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/callbacks/CallbackOperation.html#summary--">summary</a></span></code> |
| <div class="block">Provides a brief description of what this callback operation does.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="annotation.type.element.detail"> |
| <!-- --> |
| </a> |
| <h3>Element Detail</h3> |
| <a name="method--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>method</h4> |
| <pre>public abstract java.lang.String method</pre> |
| <div class="block">The HTTP method for this callback operation.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the HTTP method of this callback operation</dd> |
| </dl> |
| <dl> |
| <dt>Default:</dt> |
| <dd>""</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="summary--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>summary</h4> |
| <pre>public abstract java.lang.String summary</pre> |
| <div class="block">Provides a brief description of what this callback operation does.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a summary of this callback operation</dd> |
| </dl> |
| <dl> |
| <dt>Default:</dt> |
| <dd>""</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="description--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>description</h4> |
| <pre>public abstract java.lang.String description</pre> |
| <div class="block">A verbose description of the callback operation behavior. |
| CommonMark syntax MAY be used for rich text representation.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a description of this callback operation</dd> |
| </dl> |
| <dl> |
| <dt>Default:</dt> |
| <dd>""</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="externalDocs--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>externalDocs</h4> |
| <pre>public abstract <a href="../../../../../../org/eclipse/microprofile/openapi/annotations/ExternalDocumentation.html" title="annotation in org.eclipse.microprofile.openapi.annotations">ExternalDocumentation</a> externalDocs</pre> |
| <div class="block">Additional external documentation for this callback operation.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>external documentation associated with this callback operation instance</dd> |
| </dl> |
| <dl> |
| <dt>Default:</dt> |
| <dd>@org.eclipse.microprofile.openapi.annotations.ExternalDocumentation</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="parameters--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parameters</h4> |
| <pre>public abstract <a href="../../../../../../org/eclipse/microprofile/openapi/annotations/parameters/Parameter.html" title="annotation in org.eclipse.microprofile.openapi.annotations.parameters">Parameter</a>[] parameters</pre> |
| <div class="block">An array of parameters applicable for this callback operation, |
| which will be added to any automatically detected parameters in the method itself. |
| <p> |
| The list MUST NOT include duplicated parameters. |
| A unique parameter is defined by a combination of a name and location. |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of parameters for this callback operation</dd> |
| </dl> |
| <dl> |
| <dt>Default:</dt> |
| <dd>{}</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="requestBody--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>requestBody</h4> |
| <pre>public abstract <a href="../../../../../../org/eclipse/microprofile/openapi/annotations/parameters/RequestBody.html" title="annotation in org.eclipse.microprofile.openapi.annotations.parameters">RequestBody</a> requestBody</pre> |
| <div class="block">The request body applicable for this callback operation.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the request body of this callback operation</dd> |
| </dl> |
| <dl> |
| <dt>Default:</dt> |
| <dd>@org.eclipse.microprofile.openapi.annotations.parameters.RequestBody</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="responses--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>responses</h4> |
| <pre>public abstract <a href="../../../../../../org/eclipse/microprofile/openapi/annotations/responses/APIResponse.html" title="annotation in org.eclipse.microprofile.openapi.annotations.responses">APIResponse</a>[] responses</pre> |
| <div class="block">This is a REQUIRED property of an callback operation instance. |
| <p> |
| The list of possible responses as they are returned from executing this callback operation. |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of responses for this callback operation</dd> |
| </dl> |
| <dl> |
| <dt>Default:</dt> |
| <dd>{}</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="security--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>security</h4> |
| <pre>public abstract <a href="../../../../../../org/eclipse/microprofile/openapi/annotations/security/SecurityRequirement.html" title="annotation in org.eclipse.microprofile.openapi.annotations.security">SecurityRequirement</a>[] security</pre> |
| <div class="block">A declaration of which security mechanisms can be used for this callback operation. |
| Only one of the security requirement objects need to be satisfied to authorize a request. |
| <p> |
| This definition overrides any declared top-level security. |
| To remove a top-level security declaration, an empty array can be used.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of security mechanisms for this callback operation</dd> |
| </dl> |
| <dl> |
| <dt>Default:</dt> |
| <dd>{}</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="extensions--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>extensions</h4> |
| <pre>public abstract <a href="../../../../../../org/eclipse/microprofile/openapi/annotations/extensions/Extension.html" title="annotation in org.eclipse.microprofile.openapi.annotations.extensions">Extension</a>[] extensions</pre> |
| <div class="block">The list of optional extensions.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an optional array of extensions</dd> |
| </dl> |
| <dl> |
| <dt>Default:</dt> |
| <dd>{}</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/annotations/callbacks/Callback.html" title="annotation in org.eclipse.microprofile.openapi.annotations.callbacks"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/callbacks/Callbacks.html" title="annotation in org.eclipse.microprofile.openapi.annotations.callbacks"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/eclipse/microprofile/openapi/annotations/callbacks/CallbackOperation.html" target="_top">Frames</a></li> |
| <li><a href="CallbackOperation.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>Field | </li> |
| <li>Required | </li> |
| <li><a href="#annotation.type.optional.element.summary">Optional</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#annotation.type.element.detail">Element</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |