Google Git
Sign in
apache / tomee-site-pub / 476cf231b77b83a25b4407df84b6a5fd7c0d673a / . / microprofile-5.0 / javadoc / org / eclipse / microprofile / openapi / annotations / parameters / Parameter.html
blob: cbd522df5eebc5252b3028417049dcb06eb838f2 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>Parameter</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="Parameter";
}
}
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>Prev&nbsp;Class</li>
<li><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/parameters/Parameters.html" title="annotation in org.eclipse.microprofile.openapi.annotations.parameters"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/microprofile/openapi/annotations/parameters/Parameter.html" target="_top">Frames</a></li>
<li><a href="Parameter.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Required&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</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.parameters</div>
<h2 title="Annotation Type Parameter" class="title">Annotation Type Parameter</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>@Target(value={PARAMETER,METHOD,FIELD})
@Retention(value=RUNTIME)
@Repeatable(value=<a href="../../../../../../org/eclipse/microprofile/openapi/annotations/parameters/Parameters.html" title="annotation in org.eclipse.microprofile.openapi.annotations.parameters">Parameters.class</a>)
@Inherited
public @interface <span class="memberNameLabel">Parameter</span></pre>
<div class="block">Describes a single operation parameter</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#parameterObject">OpenAPI
Specification Parameter 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">&nbsp;</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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/parameters/Parameter.html#allowEmptyValue--">allowEmptyValue</a></span></code>
<div class="block">When true, allows sending an empty value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/parameters/Parameter.html#allowReserved--">allowReserved</a></span></code>
<div class="block">Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/media/Content.html" title="annotation in org.eclipse.microprofile.openapi.annotations.media">Content</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/parameters/Parameter.html#content--">content</a></span></code>
<div class="block">The representation of this parameter, for different media types.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/parameters/Parameter.html#deprecated--">deprecated</a></span></code>
<div class="block">Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.</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/parameters/Parameter.html#description--">description</a></span></code>
<div class="block">A brief description of the parameter.</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/parameters/Parameter.html#example--">example</a></span></code>
<div class="block">Provides an example of the schema.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/media/ExampleObject.html" title="annotation in org.eclipse.microprofile.openapi.annotations.media">ExampleObject</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/parameters/Parameter.html#examples--">examples</a></span></code>
<div class="block">Provides an array examples of the schema.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/enums/Explode.html" title="enum in org.eclipse.microprofile.openapi.annotations.enums">Explode</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/parameters/Parameter.html#explode--">explode</a></span></code>
<div class="block">When this is true, parameter values of type array or object generate separate parameters for each value of the
array or key-value pair of the map.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/parameters/Parameter.html#hidden--">hidden</a></span></code>
<div class="block">Allows this parameter to be marked as hidden</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/enums/ParameterIn.html" title="enum in org.eclipse.microprofile.openapi.annotations.enums">ParameterIn</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/parameters/Parameter.html#in--">in</a></span></code>
<div class="block">The location of the parameter.</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/parameters/Parameter.html#name--">name</a></span></code>
<div class="block">The name of the parameter.</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/parameters/Parameter.html#ref--">ref</a></span></code>
<div class="block">Reference value to a Parameter object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/parameters/Parameter.html#required--">required</a></span></code>
<div class="block">Determines whether this parameter is mandatory.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/media/Schema.html" title="annotation in org.eclipse.microprofile.openapi.annotations.media">Schema</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/parameters/Parameter.html#schema--">schema</a></span></code>
<div class="block">The schema defining the type used for the parameter.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/enums/ParameterStyle.html" title="enum in org.eclipse.microprofile.openapi.annotations.enums">ParameterStyle</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/parameters/Parameter.html#style--">style</a></span></code>
<div class="block">Describes how the parameter value will be serialized depending on the type of the parameter value.</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="name--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>name</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;name</pre>
<div class="block">The name of the parameter. Parameter names are case sensitive. It is a REQUIRED property unless this is only a
reference to a parameter instance.
<p>
When the parameter is defined within <a href="../../../../../../org/eclipse/microprofile/openapi/annotations/Components.html" title="annotation in org.eclipse.microprofile.openapi.annotations"><code>Components</code></a>, the name
will be used as the key to add this parameter to the 'parameters' map for reuse.
<p>
If in is "path", the name field MUST correspond to the associated path segment from the path field in the Paths
Object. See Path Templating for further information.
</p>
If in is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition
SHALL be ignored.
<p>
For all other cases, the name corresponds to the parameter name used by the in property.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this parameter's name</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="in--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>in</h4>
<pre>public abstract&nbsp;<a href="../../../../../../org/eclipse/microprofile/openapi/annotations/enums/ParameterIn.html" title="enum in org.eclipse.microprofile.openapi.annotations.enums">ParameterIn</a>&nbsp;in</pre>
<div class="block">The location of the parameter. It is a REQUIRED property unless this is only a reference to a parameter instance.
<p>
Possible values are specified in ParameterIn enum. Ignored when empty string.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this parameter's location</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>org.eclipse.microprofile.openapi.annotations.enums.ParameterIn.DEFAULT</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&nbsp;java.lang.String&nbsp;description</pre>
<div class="block">A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich
text representation.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this parameter's description</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="required--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>required</h4>
<pre>public abstract&nbsp;boolean&nbsp;required</pre>
<div class="block">Determines whether this parameter is mandatory.
<p>
If the parameter location is "path", this property is REQUIRED and its value MUST be true. Otherwise, the
property may be included and its default value is false.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether or not this parameter is required</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>false</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="deprecated--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deprecated</h4>
<pre>public abstract&nbsp;boolean&nbsp;deprecated</pre>
<div class="block">Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether or not this parameter is deprecated</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>false</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="allowEmptyValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allowEmptyValue</h4>
<pre>public abstract&nbsp;boolean&nbsp;allowEmptyValue</pre>
<div class="block">When true, allows sending an empty value. If false, the parameter will be considered \&quot;null\&quot; if no
value is present.
<p>
This may create validation errors when the parameter is required. Valid only for query parameters and allows
sending a parameter with an empty value.
</p>
If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether or not this parameter allows empty values</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>false</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="style--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>style</h4>
<pre>public abstract&nbsp;<a href="../../../../../../org/eclipse/microprofile/openapi/annotations/enums/ParameterStyle.html" title="enum in org.eclipse.microprofile.openapi.annotations.enums">ParameterStyle</a>&nbsp;style</pre>
<div class="block">Describes how the parameter value will be serialized depending on the type of the parameter value.
<p>
Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie -
form.
</p>
Ignored if the properties content or array are specified.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the style of this parameter</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>org.eclipse.microprofile.openapi.annotations.enums.ParameterStyle.DEFAULT</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="explode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>explode</h4>
<pre>public abstract&nbsp;<a href="../../../../../../org/eclipse/microprofile/openapi/annotations/enums/Explode.html" title="enum in org.eclipse.microprofile.openapi.annotations.enums">Explode</a>&nbsp;explode</pre>
<div class="block">When this is true, parameter values of type array or object generate separate parameters for each value of the
array or key-value pair of the map.
<p>
For other types of parameters this property has no effect. When style is form, the default value is true. For all
other styles, the default value is false.
</p>
Ignored if the properties content or array are specified.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether or not to expand individual array members</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>org.eclipse.microprofile.openapi.annotations.enums.Explode.DEFAULT</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="allowReserved--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allowReserved</h4>
<pre>public abstract&nbsp;boolean&nbsp;allowReserved</pre>
<div class="block">Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986.
<p>
This property only applies to parameters with an in value of query. Ignored if the properties content or array
are specified.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether or not this parameter allows reserved characters</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>false</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="schema--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>schema</h4>
<pre>public abstract&nbsp;<a href="../../../../../../org/eclipse/microprofile/openapi/annotations/media/Schema.html" title="annotation in org.eclipse.microprofile.openapi.annotations.media">Schema</a>&nbsp;schema</pre>
<div class="block">The schema defining the type used for the parameter. Ignored if the properties content or array are specified.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the schema of this parameter</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>@org.eclipse.microprofile.openapi.annotations.media.Schema</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="content--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>content</h4>
<pre>public abstract&nbsp;<a href="../../../../../../org/eclipse/microprofile/openapi/annotations/media/Content.html" title="annotation in org.eclipse.microprofile.openapi.annotations.media">Content</a>[]&nbsp;content</pre>
<div class="block">The representation of this parameter, for different media types.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the content of this parameter</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="hidden--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hidden</h4>
<pre>public abstract&nbsp;boolean&nbsp;hidden</pre>
<div class="block">Allows this parameter to be marked as hidden</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether or not this parameter is hidden</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>false</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="examples--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>examples</h4>
<pre>public abstract&nbsp;<a href="../../../../../../org/eclipse/microprofile/openapi/annotations/media/ExampleObject.html" title="annotation in org.eclipse.microprofile.openapi.annotations.media">ExampleObject</a>[]&nbsp;examples</pre>
<div class="block">Provides an array examples of the schema. Each example SHOULD contain a value in the correct format as specified
in the parameter encoding. Furthermore, if referencing a schema which contains an example, the examples value
SHALL override the example provided by the schema.
<p>
When associated with a specific media type, the example string shall be parsed by the consumer to be treated as
an object or an array.
</p>
Ignored if the properties content or array are specified.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the list of examples for this parameter</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="example--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>example</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;example</pre>
<div class="block">Provides an example of the schema. The example SHOULD match the specified schema and encoding properties if
present. Furthermore, if referencing a schema which contains an example, the example value SHALL override the
example provided by the schema. To represent examples of media types that cannot naturally be represented in JSON
or YAML, a string value can contain the example with escaping where necessary.
<p>
When associated with a specific media type, the example string SHALL be parsed by the consumer to be treated as
an object or an array.
</p>
Ignored if the properties examples, content or array are specified.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an example of the parameter</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="ref--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ref</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;ref</pre>
<div class="block">Reference value to a Parameter object.
<p>
This property provides a reference to an object defined elsewhere. This property and all other properties are
mutually exclusive. If other properties are defined in addition to the ref property then the result is undefined.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>reference to a parameter</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>Prev&nbsp;Class</li>
<li><a href="../../../../../../org/eclipse/microprofile/openapi/annotations/parameters/Parameters.html" title="annotation in org.eclipse.microprofile.openapi.annotations.parameters"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/microprofile/openapi/annotations/parameters/Parameter.html" target="_top">Frames</a></li>
<li><a href="Parameter.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Required&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</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>