| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>OpenApiConfig (Apache Juneau 8.1.4)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../javadoc.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="OpenApiConfig (Apache Juneau 8.1.4)"; |
| } |
| } |
| 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/apache/juneau/oapi/annotation/OpenApiAnnotation.html" title="class in org.apache.juneau.oapi.annotation"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/juneau/oapi/annotation/OpenApiConfigApply.html" title="class in org.apache.juneau.oapi.annotation"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/juneau/oapi/annotation/OpenApiConfig.html" target="_top">Frames</a></li> |
| <li><a href="OpenApiConfig.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.apache.juneau.oapi.annotation</div> |
| <h2 title="Annotation Type OpenApiConfig" class="title">Annotation Type OpenApiConfig</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Documented.html?is-external=true" title="class or interface in java.lang.annotation">@Documented</a> |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>={<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE" title="class or interface in java.lang.annotation">TYPE</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation">METHOD</a>}) |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>) |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Inherited.html?is-external=true" title="class or interface in java.lang.annotation">@Inherited</a> |
| <a href="../../../../../org/apache/juneau/annotation/PropertyStoreApply.html" title="annotation in org.apache.juneau.annotation">@PropertyStoreApply</a>(<a href="../../../../../org/apache/juneau/annotation/PropertyStoreApply.html#value--">value</a>=<a href="../../../../../org/apache/juneau/oapi/annotation/OpenApiConfigApply.html" title="class in org.apache.juneau.oapi.annotation">OpenApiConfigApply.class</a>) |
| public @interface <a href="../../../../../src-html/org/apache/juneau/oapi/annotation/OpenApiConfig.html#line.35">OpenApiConfig</a></pre> |
| <div class="block">Annotation for specifying config properties defined in <a href="../../../../../org/apache/juneau/msgpack/MsgPackSerializer.html" title="class in org.apache.juneau.msgpack"><code>MsgPackSerializer</code></a> and <a href="../../../../../org/apache/juneau/msgpack/MsgPackParser.html" title="class in org.apache.juneau.msgpack"><code>MsgPackParser</code></a>. |
| |
| <p> |
| Used primarily for specifying bean configuration properties on REST classes and methods.</div> |
| </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><a href="../../../../../org/apache/juneau/oapi/annotation/OpenApi.html" title="annotation in org.apache.juneau.oapi.annotation">OpenApi</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/oapi/annotation/OpenApiConfig.html#applyOpenApi--">applyOpenApi</a></span></code> |
| <div class="block">Dynamically applies <a href="../../../../../org/apache/juneau/oapi/annotation/OpenApi.html" title="annotation in org.apache.juneau.oapi.annotation"><code>@OpenApi</code></a> annotations to specified classes/methods/fields.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/oapi/annotation/OpenApiConfig.html#collectionFormat--">collectionFormat</a></span></code> |
| <div class="block">Configuration property: Default collection format for HTTP parts.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/oapi/annotation/OpenApiConfig.html#format--">format</a></span></code> |
| <div class="block">Default format for HTTP parts.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/oapi/annotation/OpenApiConfig.html#rank--">rank</a></span></code> |
| <div class="block">Optional rank for this config.</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="rank--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rank</h4> |
| <pre>public abstract int <a href="../../../../../src-html/org/apache/juneau/oapi/annotation/OpenApiConfig.html#line.43">rank</a></pre> |
| <div class="block">Optional rank for this config. |
| |
| <p> |
| Can be used to override default ordering and application of config annotations.</div> |
| <dl> |
| <dt>Default:</dt> |
| <dd>0</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="applyOpenApi--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>applyOpenApi</h4> |
| <pre>public abstract <a href="../../../../../org/apache/juneau/oapi/annotation/OpenApi.html" title="annotation in org.apache.juneau.oapi.annotation">OpenApi</a>[] <a href="../../../../../src-html/org/apache/juneau/oapi/annotation/OpenApiConfig.html#line.60">applyOpenApi</a></pre> |
| <div class="block">Dynamically applies <a href="../../../../../org/apache/juneau/oapi/annotation/OpenApi.html" title="annotation in org.apache.juneau.oapi.annotation"><code>@OpenApi</code></a> annotations to specified classes/methods/fields. |
| |
| <p> |
| Provides an alternate approach for applying annotations using <a href="../../../../../org/apache/juneau/oapi/annotation/OpenApi.html#on--"><code>@OpenApi.on</code></a> to specify the names |
| to apply the annotation to. |
| |
| <ul class='seealso'> |
| <li class='link'><a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.DynamicallyAppliedAnnotations'>Overview > juneau-marshall > Dynamically Applied Annotations</a> |
| </ul></div> |
| <dl> |
| <dt>Default:</dt> |
| <dd>{}</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="format--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>format</h4> |
| <pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/oapi/annotation/OpenApiConfig.html#line.92">format</a></pre> |
| <div class="block">Default format for HTTP parts. |
| |
| <p> |
| Specifies the format to use for HTTP parts when not otherwise specified via <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#format--"><code>Schema.format()</code></a>. |
| |
| <p> |
| Possible values: |
| <ul class='javatree'> |
| <li class='jc'><a href="../../../../../org/apache/juneau/httppart/HttpPartFormat.html" title="enum in org.apache.juneau.httppart"><code>HttpPartFormat</code></a> |
| <ul> |
| <li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartFormat.html#UON"><code>UON</code></a> - UON notation (e.g. <js>"'foo bar'"</js>). |
| <li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartFormat.html#INT32"><code>INT32</code></a> - Signed 32 bits. |
| <li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartFormat.html#INT64"><code>INT64</code></a> - Signed 64 bits. |
| <li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartFormat.html#FLOAT"><code>FLOAT</code></a> - 32-bit floating point number. |
| <li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartFormat.html#DOUBLE"><code>DOUBLE</code></a> - 64-bit floating point number. |
| <li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartFormat.html#BYTE"><code>BYTE</code></a> - BASE-64 encoded characters. |
| <li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartFormat.html#BINARY"><code>BINARY</code></a> - Hexadecimal encoded octets (e.g. <js>"00FF"</js>). |
| <li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartFormat.html#BINARY_SPACED"><code>BINARY_SPACED</code></a> - Spaced-separated hexadecimal encoded octets (e.g. <js>"00 FF"</js>). |
| <li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartFormat.html#DATE"><code>DATE</code></a> - An <a href='http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14'>RFC3339 full-date</a>. |
| <li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartFormat.html#DATE_TIME"><code>DATE_TIME</code></a> - An <a href='http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14'>RFC3339 date-time</a>. |
| <li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartFormat.html#PASSWORD"><code>PASSWORD</code></a> - Used to hint UIs the input needs to be obscured. |
| <li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartFormat.html#NO_FORMAT"><code>NO_FORMAT</code></a> - (default) Not specified. |
| </ul> |
| </ul> |
| |
| <ul class='seealso'> |
| <li class='jf'><a href="../../../../../org/apache/juneau/oapi/OpenApiCommon.html#OAPI_format"><code>OpenApiCommon.OAPI_format</code></a> |
| </ul></div> |
| <dl> |
| <dt>Default:</dt> |
| <dd>""</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="collectionFormat--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>collectionFormat</h4> |
| <pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/oapi/annotation/OpenApiConfig.html#line.118">collectionFormat</a></pre> |
| <div class="block">Configuration property: Default collection format for HTTP parts. |
| |
| <p> |
| Specifies the collection format to use for HTTP parts when not otherwise specified via <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#collectionFormat--"><code>Schema.collectionFormat()</code></a>. |
| |
| <p> |
| Possible values: |
| <ul class='javatree'> |
| <li class='jc'><a href="../../../../../org/apache/juneau/httppart/HttpPartFormat.html" title="enum in org.apache.juneau.httppart"><code>HttpPartFormat</code></a> |
| <ul> |
| <li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartCollectionFormat.html#CSV"><code>CSV</code></a> - (default) Comma-separated values (e.g. <js>"foo,bar"</js>). |
| <li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartCollectionFormat.html#SSV"><code>SSV</code></a> - Space-separated values (e.g. <js>"foo bar"</js>). |
| <li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartCollectionFormat.html#TSV"><code>TSV</code></a> - Tab-separated values (e.g. <js>"foo\tbar"</js>). |
| <li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartCollectionFormat.html#PIPES"><code>PIPES</code></a> - Pipe-separated values (e.g. <js>"foo|bar"</js>). |
| <li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartCollectionFormat.html#MULTI"><code>MULTI</code></a> - Corresponds to multiple parameter instances instead of multiple values for a single instance (e.g. <js>"foo=bar&foo=baz"</js>). |
| <li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartCollectionFormat.html#UONC"><code>UONC</code></a> - UON collection notation (e.g. <js>"@(foo,bar)"</js>). |
| </ul> |
| </ul> |
| |
| <ul class='seealso'> |
| <li class='jf'><a href="../../../../../org/apache/juneau/oapi/OpenApiCommon.html#OAPI_collectionFormat"><code>OpenApiCommon.OAPI_collectionFormat</code></a> |
| </ul></div> |
| <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/apache/juneau/oapi/annotation/OpenApiAnnotation.html" title="class in org.apache.juneau.oapi.annotation"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/juneau/oapi/annotation/OpenApiConfigApply.html" title="class in org.apache.juneau.oapi.annotation"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/juneau/oapi/annotation/OpenApiConfig.html" target="_top">Frames</a></li> |
| <li><a href="OpenApiConfig.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 ======= --> |
| <p class="legalCopy"><small>Copyright © 2016–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |