content/site/apidocs-9.0.0/org/apache/juneau/jsonschema/annotation/Schema.html - juneau-website - Git at Google

 <!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>Schema (Apache Juneau 8.2.0)</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="Schema (Apache Juneau 8.2.0)";
         }
     }
     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/jsonschema/annotation/JsonSchemaConfigApply.html" title="class in org.apache.juneau.jsonschema.annotation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../../org/apache/juneau/jsonschema/annotation/SchemaAnnotation.html" title="class in org.apache.juneau.jsonschema.annotation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../index.html?org/apache/juneau/jsonschema/annotation/Schema.html" target="_top">Frames</a></li>
 <li><a href="Schema.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.apache.juneau.jsonschema.annotation</div>
 <h2 title="Annotation Type Schema" class="title">Annotation Type Schema</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/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>)
 public @interface <a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.78">Schema</a></pre>
 <div class="block">Swagger schema annotation.

  <p>
  The Schema Object allows the definition of input and output data types.
  These types can be objects, but also primitives and arrays.
  This object is based on the JSON Schema Specification Draft 4 and uses a predefined subset of it.
  On top of this subset, there are extensions provided by this specification to allow for more complete documentation.

  <p>
  Used to populate the auto-generated Swagger documentation and UI for server-side <ja>@Rest</ja>-annotated classes.
  <br>Also used to define OpenAPI schema information for POJOs serialized through <a href="../../../../../org/apache/juneau/oapi/OpenApiSerializer.html" title="class in org.apache.juneau.oapi"><code>OpenApiSerializer</code></a> and parsed through <a href="../../../../../org/apache/juneau/oapi/OpenApiParser.html" title="class in org.apache.juneau.oapi"><code>OpenApiParser</code></a>.

  <h5 class='section'>Examples:</h5>
  <p class='bcode w800'>
    <jc>// A response object thats a hex-encoded string</jc>
    <ja>@Response</ja>(
       schema=<ja>@Schema</ja>(
          type=<js>"string"</js>,
          format=<js>"binary"</js>
       )
    )
  </p>
  <p class='bcode w800'>
    <jc>// Free-form</jc>
    <ja>@Response</ja>(
       schema=<ja>@Schema</ja>({
          <js>"type:'string',"</js>,
          <js>"format:'binary'"</js>
       })
    )
  </p>
  <p class='bcode w800'>
    <jc>// A request body consisting of an array of arrays, the internal array being of type integer, numbers must be between 0 and 63 (inclusive)</jc>
 </jc>
    <ja>@Body</ja>(
       schema=<ja>@Schema</ja>(
          items=<ja>@Items</ja>(
             type=<js>"array"</js>,
             items=<ja>@SubItems</ja>(
                type=<js>"integer"</js>,
                minimum=<js>"0"</js>,
                maximum=<js>"63"</js>
             )
          )
       )
    )
  </p>

  <ul class='seealso'>
    <li class='link'><a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.RestSwagger'>Overview &gt; juneau-rest-server &gt; Swagger</a>
    <li class='extlink'><a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>
  </ul></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">&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><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/jsonschema/annotation/Schema.html#Z:Z_default--">_default</a></span></code>
 <div class="block"><mk>default</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.</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/jsonschema/annotation/Schema.html#Z:Z_enum--">_enum</a></span></code>
 <div class="block"><mk>enum</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.</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/jsonschema/annotation/Schema.html#Z:Z:Dref--">$ref</a></span></code>
 <div class="block"><mk>$ref</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.</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/jsonschema/annotation/Schema.html#additionalProperties--">additionalProperties</a></span></code>
 <div class="block"><mk>additionalProperties</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.</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/jsonschema/annotation/Schema.html#allOf--">allOf</a></span></code>
 <div class="block"><mk>allOf</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.</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/jsonschema/annotation/Schema.html#cf--">cf</a></span></code>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#collectionFormat--"><code>collectionFormat()</code></a>.</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/jsonschema/annotation/Schema.html#collectionFormat--">collectionFormat</a></span></code>
 <div class="block"><mk>collectionFormat</mk> field.</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/jsonschema/annotation/Schema.html#d--">d</a></span></code>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#description--"><code>description()</code></a>.</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/jsonschema/annotation/Schema.html#description--">description</a></span></code>
 <div class="block"><mk>description</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.</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/jsonschema/annotation/Schema.html#df--">df</a></span></code>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#Z:Z_default--"><code>_default()</code></a>.</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/jsonschema/annotation/Schema.html#discriminator--">discriminator</a></span></code>
 <div class="block"><mk>discriminator</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.</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/jsonschema/annotation/Schema.html#e--">e</a></span></code>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#Z:Z_enum--"><code>_enum()</code></a>.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#emax--">emax</a></span></code>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#exclusiveMaximum--"><code>exclusiveMaximum()</code></a>.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#emin--">emin</a></span></code>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#exclusiveMinimum--"><code>exclusiveMinimum()</code></a>.</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/jsonschema/annotation/Schema.html#ex--">ex</a></span></code>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#readOnly--"><code>readOnly()</code></a>.</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/jsonschema/annotation/Schema.html#example--">example</a></span></code>
 <div class="block"><mk>example</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.</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/jsonschema/annotation/Schema.html#examples--">examples</a></span></code>
 <div class="block"><mk>x-examples</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#exclusiveMaximum--">exclusiveMaximum</a></span></code>
 <div class="block"><mk>exclusiveMaximum</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#exclusiveMinimum--">exclusiveMinimum</a></span></code>
 <div class="block"><mk>exclusiveMinimum</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.</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/jsonschema/annotation/Schema.html#exs--">exs</a></span></code>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#examples--"><code>examples()</code></a>.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code><a href="../../../../../org/apache/juneau/jsonschema/annotation/ExternalDocs.html" title="annotation in org.apache.juneau.jsonschema.annotation">ExternalDocs</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#externalDocs--">externalDocs</a></span></code>
 <div class="block"><mk>externalDocs</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.</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/jsonschema/annotation/Schema.html#f--">f</a></span></code>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#format--"><code>format()</code></a>.</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/jsonschema/annotation/Schema.html#format--">format</a></span></code>
 <div class="block"><mk>format</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#ignore--">ignore</a></span></code>
 <div class="block">Specifies that schema information for this part should not be shown in the generated Swagger documentation.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code><a href="../../../../../org/apache/juneau/jsonschema/annotation/Items.html" title="annotation in org.apache.juneau.jsonschema.annotation">Items</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#items--">items</a></span></code>
 <div class="block"><mk>items</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.</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/jsonschema/annotation/Schema.html#max--">max</a></span></code>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#maximum--"><code>maximum()</code></a>.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>long</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#maxi--">maxi</a></span></code>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#maxItems--"><code>maxItems()</code></a>.</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/jsonschema/annotation/Schema.html#maximum--">maximum</a></span></code>
 <div class="block"><mk>maximum</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>long</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#maxItems--">maxItems</a></span></code>
 <div class="block"><mk>maxItems</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>long</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#maxl--">maxl</a></span></code>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#maxLength--"><code>maxLength()</code></a>.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>long</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#maxLength--">maxLength</a></span></code>
 <div class="block"><mk>maxLength</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>long</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#maxp--">maxp</a></span></code>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#maxProperties--"><code>maxProperties()</code></a>.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>long</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#maxProperties--">maxProperties</a></span></code>
 <div class="block"><mk>maxProperties</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.</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/jsonschema/annotation/Schema.html#min--">min</a></span></code>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#minimum--"><code>minimum()</code></a>.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>long</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#mini--">mini</a></span></code>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#minItems--"><code>minItems()</code></a>.</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/jsonschema/annotation/Schema.html#minimum--">minimum</a></span></code>
 <div class="block"><mk>minimum</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>long</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#minItems--">minItems</a></span></code>
 <div class="block"><mk>minItems</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>long</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#minl--">minl</a></span></code>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#minLength--"><code>minLength()</code></a>.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>long</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#minLength--">minLength</a></span></code>
 <div class="block"><mk>minLength</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>long</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#minp--">minp</a></span></code>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#minProperties--"><code>minProperties()</code></a>.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>long</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#minProperties--">minProperties</a></span></code>
 <div class="block"><mk>minProperties</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.</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/jsonschema/annotation/Schema.html#mo--">mo</a></span></code>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#multipleOf--"><code>multipleOf()</code></a>.</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/jsonschema/annotation/Schema.html#multipleOf--">multipleOf</a></span></code>
 <div class="block"><mk>multipleOf</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.</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/jsonschema/annotation/Schema.html#on--">on</a></span></code>
 <div class="block">Dynamically apply this annotation to the specified classes/methods/fields.</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/jsonschema/annotation/Schema.html#p--">p</a></span></code>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#pattern--"><code>pattern()</code></a>.</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/jsonschema/annotation/Schema.html#pattern--">pattern</a></span></code>
 <div class="block"><mk>pattern</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.</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/jsonschema/annotation/Schema.html#properties--">properties</a></span></code>
 <div class="block"><mk>properties</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#r--">r</a></span></code>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#required--"><code>required()</code></a>.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#readOnly--">readOnly</a></span></code>
 <div class="block"><mk>readOnly</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#required--">required</a></span></code>
 <div class="block"><mk>required</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#ro--">ro</a></span></code>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#readOnly--"><code>readOnly()</code></a>.</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/jsonschema/annotation/Schema.html#t--">t</a></span></code>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#type--"><code>type()</code></a>.</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/jsonschema/annotation/Schema.html#title--">title</a></span></code>
 <div class="block"><mk>title</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.</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/jsonschema/annotation/Schema.html#type--">type</a></span></code>
 <div class="block"><mk>type</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#ui--">ui</a></span></code>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#uniqueItems--"><code>uniqueItems()</code></a>.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#uniqueItems--">uniqueItems</a></span></code>
 <div class="block"><mk>uniqueItems</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.</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/jsonschema/annotation/Schema.html#value--">value</a></span></code>
 <div class="block">Free-form value for the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.</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/jsonschema/annotation/Schema.html#xml--">xml</a></span></code>
 <div class="block"><mk>xml</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.</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="Z:Z:Dref--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>$ref</h4>
 <pre>public abstract&nbsp;<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>&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.94">$ref</a></pre>
 <div class="block"><mk>$ref</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.

  <p>
    A JSON reference to the schema definition.

  <ul class='notes'>
    <li>
       The format is a <a href='https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03'>JSON Reference</a>.
    <li>
       Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.RestSvlVariables'>Overview &gt; juneau-rest-server &gt; SVL Variables</a>
       (e.g. <js>"$L{my.localized.variable}"</js>).
  </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&nbsp;<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>&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.120">format</a></pre>
 <div class="block"><mk>format</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.

  <h5 class='section'>Examples:</h5>
  <p class='bcode w800'>
    <jc>// Used on parameter</jc>
    <ja>@RestMethod</ja>(name=<jsf>PUT</jsf>)
    <jk>public void</jk> setAge(
       <ja>@Body</ja>(type=<js>"integer"</js>, format=<js>"int32"</js>) String input
    ) {...}
  </p>

  <ul class='notes'>
    <li>
       The format is plain text.
    <li>
       Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.RestSvlVariables'>Overview &gt; juneau-rest-server &gt; SVL Variables</a>
       (e.g. <js>"$L{my.localized.variable}"</js>).
  </ul>

  <ul class='seealso'>
    <li class='extlink'><a class='doclink' href='https://swagger.io/specification#dataTypeFormat'>Swagger Data Type Formats</a>
  </ul></div>
 <dl>
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="f--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>f</h4>
 <pre>public abstract&nbsp;<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>&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.125">f</a></pre>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#format--"><code>format()</code></a>.</div>
 <dl>
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="title--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>title</h4>
 <pre>public abstract&nbsp;<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>&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.138">title</a></pre>
 <div class="block"><mk>title</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.

  <ul class='notes'>
    <li>
       The format is plain text.
    <li>
       Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.RestSvlVariables'>Overview &gt; juneau-rest-server &gt; SVL Variables</a>
       (e.g. <js>"$L{my.localized.variable}"</js>).
  </ul></div>
 <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&nbsp;<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>[]&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.172">description</a></pre>
 <div class="block"><mk>description</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.

  <p>
  A brief description of the body. This could contain examples of use.

  <h5 class='section'>Examples:</h5>
  <p class='bcode w800'>
    <jc>// Used on parameter</jc>
    <ja>@RestMethod</ja>(name=<jsf>POST</jsf>)
    <jk>public void</jk> addPet(
       <ja>@Body</ja>(description=<js>"Pet object to add to the store"</js>) Pet input
    ) {...}
  </p>
  <p class='bcode w800'>
    <jc>// Used on class</jc>
    <ja>@RestMethod</ja>(name=<jsf>POST</jsf>)
    <jk>public void</jk> addPet(Pet input) {...}

    <ja>@Body</ja>(description=<js>"Pet object to add to the store"</js>)
    <jk>public class</jk> Pet {...}
  </p>

  <ul class='notes'>
    <li>
       The format is plain text.
       <br>Multiple lines are concatenated with newlines.
    <li>
       Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.RestSvlVariables'>Overview &gt; juneau-rest-server &gt; SVL Variables</a>
       (e.g. <js>"$L{my.localized.variable}"</js>).
  </ul></div>
 <dl>
 <dt>Default:</dt>
 <dd>{}</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="d--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>d</h4>
 <pre>public abstract&nbsp;<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>[]&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.177">d</a></pre>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#description--"><code>description()</code></a>.</div>
 <dl>
 <dt>Default:</dt>
 <dd>{}</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="Z:Z_default--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>_default</h4>
 <pre>public abstract&nbsp;<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>[]&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.191">_default</a></pre>
 <div class="block"><mk>default</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.

  <ul class='notes'>
    <li>
       The format is any <a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.JsonDetails.SimplifiedJson'>Overview &gt; juneau-marshall &gt; JSON Details &gt; Simplified JSON</a>.
       <br>Multiple lines are concatenated with newlines.
    <li>
       Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.RestSvlVariables'>Overview &gt; juneau-rest-server &gt; SVL Variables</a>
       (e.g. <js>"$L{my.localized.variable}"</js>).
  </ul></div>
 <dl>
 <dt>Default:</dt>
 <dd>{}</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="df--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>df</h4>
 <pre>public abstract&nbsp;<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>[]&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.196">df</a></pre>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#Z:Z_default--"><code>_default()</code></a>.</div>
 <dl>
 <dt>Default:</dt>
 <dd>{}</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="multipleOf--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>multipleOf</h4>
 <pre>public abstract&nbsp;<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>&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.209">multipleOf</a></pre>
 <div class="block"><mk>multipleOf</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.

  <ul class='notes'>
    <li>
       The format is numeric.
    <li>
       Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.RestSvlVariables'>Overview &gt; juneau-rest-server &gt; SVL Variables</a>
       (e.g. <js>"$L{my.localized.variable}"</js>).
  </ul></div>
 <dl>
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="mo--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>mo</h4>
 <pre>public abstract&nbsp;<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>&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.214">mo</a></pre>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#multipleOf--"><code>multipleOf()</code></a>.</div>
 <dl>
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="maximum--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>maximum</h4>
 <pre>public abstract&nbsp;<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>&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.227">maximum</a></pre>
 <div class="block"><mk>maximum</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.

  <ul class='notes'>
    <li>
       The format is numeric.
    <li>
       Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.RestSvlVariables'>Overview &gt; juneau-rest-server &gt; SVL Variables</a>
       (e.g. <js>"$L{my.localized.variable}"</js>).
  </ul></div>
 <dl>
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="max--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>max</h4>
 <pre>public abstract&nbsp;<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>&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.232">max</a></pre>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#maximum--"><code>maximum()</code></a>.</div>
 <dl>
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="exclusiveMaximum--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>exclusiveMaximum</h4>
 <pre>public abstract&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.245">exclusiveMaximum</a></pre>
 <div class="block"><mk>exclusiveMaximum</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.

  <ul class='notes'>
    <li>
       The format is numeric.
    <li>
       Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.RestSvlVariables'>Overview &gt; juneau-rest-server &gt; SVL Variables</a>
       (e.g. <js>"$L{my.localized.variable}"</js>).
  </ul></div>
 <dl>
 <dt>Default:</dt>
 <dd>false</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="emax--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>emax</h4>
 <pre>public abstract&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.250">emax</a></pre>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#exclusiveMaximum--"><code>exclusiveMaximum()</code></a>.</div>
 <dl>
 <dt>Default:</dt>
 <dd>false</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="minimum--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>minimum</h4>
 <pre>public abstract&nbsp;<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>&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.263">minimum</a></pre>
 <div class="block"><mk>minimum</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.

  <ul class='notes'>
    <li>
       The format is numeric.
    <li>
       Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.RestSvlVariables'>Overview &gt; juneau-rest-server &gt; SVL Variables</a>
       (e.g. <js>"$L{my.localized.variable}"</js>).
  </ul></div>
 <dl>
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="min--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>min</h4>
 <pre>public abstract&nbsp;<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>&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.268">min</a></pre>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#minimum--"><code>minimum()</code></a>.</div>
 <dl>
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="exclusiveMinimum--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>exclusiveMinimum</h4>
 <pre>public abstract&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.281">exclusiveMinimum</a></pre>
 <div class="block"><mk>exclusiveMinimum</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.

  <ul class='notes'>
    <li>
       The format is numeric.
    <li>
       Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.RestSvlVariables'>Overview &gt; juneau-rest-server &gt; SVL Variables</a>
       (e.g. <js>"$L{my.localized.variable}"</js>).
  </ul></div>
 <dl>
 <dt>Default:</dt>
 <dd>false</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="emin--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>emin</h4>
 <pre>public abstract&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.286">emin</a></pre>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#exclusiveMinimum--"><code>exclusiveMinimum()</code></a>.</div>
 <dl>
 <dt>Default:</dt>
 <dd>false</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="maxLength--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>maxLength</h4>
 <pre>public abstract&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.299">maxLength</a></pre>
 <div class="block"><mk>maxLength</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.

  <ul class='notes'>
    <li>
       The format is numeric.
    <li>
       Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.RestSvlVariables'>Overview &gt; juneau-rest-server &gt; SVL Variables</a>
       (e.g. <js>"$L{my.localized.variable}"</js>).
  </ul></div>
 <dl>
 <dt>Default:</dt>
 <dd>-1L</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="maxl--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>maxl</h4>
 <pre>public abstract&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.304">maxl</a></pre>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#maxLength--"><code>maxLength()</code></a>.</div>
 <dl>
 <dt>Default:</dt>
 <dd>-1L</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="minLength--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>minLength</h4>
 <pre>public abstract&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.317">minLength</a></pre>
 <div class="block"><mk>minLength</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.

  <ul class='notes'>
    <li>
       The format is numeric.
    <li>
       Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.RestSvlVariables'>Overview &gt; juneau-rest-server &gt; SVL Variables</a>
       (e.g. <js>"$L{my.localized.variable}"</js>).
  </ul></div>
 <dl>
 <dt>Default:</dt>
 <dd>-1L</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="minl--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>minl</h4>
 <pre>public abstract&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.322">minl</a></pre>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#minLength--"><code>minLength()</code></a>.</div>
 <dl>
 <dt>Default:</dt>
 <dd>-1L</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="pattern--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>pattern</h4>
 <pre>public abstract&nbsp;<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>&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.343">pattern</a></pre>
 <div class="block"><mk>pattern</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.

  <h5 class='section'>Example:</h5>
  <p class='bcode w800'>
    <ja>@RestMethod</ja>(name=<jsf>PUT</jsf>)
    <jk>public void</jk> doPut(<ja>@Body</ja>(format=<js>"/\\w+\\.\\d+/"</js>) String input) {...}
  </p>

  <ul class='notes'>
    <li>
       The format is plain text.
    <li>
       This string SHOULD be a valid regular expression.
    <li>
       Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.RestSvlVariables'>Overview &gt; juneau-rest-server &gt; SVL Variables</a>
       (e.g. <js>"$L{my.localized.variable}"</js>).
  </ul></div>
 <dl>
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="p--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>p</h4>
 <pre>public abstract&nbsp;<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>&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.348">p</a></pre>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#pattern--"><code>pattern()</code></a>.</div>
 <dl>
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="maxItems--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>maxItems</h4>
 <pre>public abstract&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.361">maxItems</a></pre>
 <div class="block"><mk>maxItems</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.

  <ul class='notes'>
    <li>
       The format is numeric.
    <li>
       Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.RestSvlVariables'>Overview &gt; juneau-rest-server &gt; SVL Variables</a>
       (e.g. <js>"$L{my.localized.variable}"</js>).
  </ul></div>
 <dl>
 <dt>Default:</dt>
 <dd>-1L</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="maxi--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>maxi</h4>
 <pre>public abstract&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.366">maxi</a></pre>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#maxItems--"><code>maxItems()</code></a>.</div>
 <dl>
 <dt>Default:</dt>
 <dd>-1L</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="minItems--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>minItems</h4>
 <pre>public abstract&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.379">minItems</a></pre>
 <div class="block"><mk>minItems</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.

  <ul class='notes'>
    <li>
       The format is numeric.
    <li>
       Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.RestSvlVariables'>Overview &gt; juneau-rest-server &gt; SVL Variables</a>
       (e.g. <js>"$L{my.localized.variable}"</js>).
  </ul></div>
 <dl>
 <dt>Default:</dt>
 <dd>-1L</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="mini--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>mini</h4>
 <pre>public abstract&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.384">mini</a></pre>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#minItems--"><code>minItems()</code></a>.</div>
 <dl>
 <dt>Default:</dt>
 <dd>-1L</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="uniqueItems--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>uniqueItems</h4>
 <pre>public abstract&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.397">uniqueItems</a></pre>
 <div class="block"><mk>uniqueItems</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.

  <ul class='notes'>
    <li>
       The format is boolean.
    <li>
       Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.RestSvlVariables'>Overview &gt; juneau-rest-server &gt; SVL Variables</a>
       (e.g. <js>"$L{my.localized.variable}"</js>).
  </ul></div>
 <dl>
 <dt>Default:</dt>
 <dd>false</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="ui--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>ui</h4>
 <pre>public abstract&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.402">ui</a></pre>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#uniqueItems--"><code>uniqueItems()</code></a>.</div>
 <dl>
 <dt>Default:</dt>
 <dd>false</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="maxProperties--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>maxProperties</h4>
 <pre>public abstract&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.416">maxProperties</a></pre>
 <div class="block"><mk>maxProperties</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.

  <ul class='notes'>
    <li>
       The format is a <a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.JsonDetails.SimplifiedJson'>Overview &gt; juneau-marshall &gt; JSON Details &gt; Simplified JSON</a> object.
       <br>Multiple lines are concatenated with newlines.
    <li>
       Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.RestSvlVariables'>Overview &gt; juneau-rest-server &gt; SVL Variables</a>
       (e.g. <js>"$L{my.localized.variable}"</js>).
  </ul></div>
 <dl>
 <dt>Default:</dt>
 <dd>-1L</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="maxp--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>maxp</h4>
 <pre>public abstract&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.421">maxp</a></pre>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#maxProperties--"><code>maxProperties()</code></a>.</div>
 <dl>
 <dt>Default:</dt>
 <dd>-1L</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="minProperties--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>minProperties</h4>
 <pre>public abstract&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.435">minProperties</a></pre>
 <div class="block"><mk>minProperties</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.

  <ul class='notes'>
    <li>
       The format is a <a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.JsonDetails.SimplifiedJson'>Overview &gt; juneau-marshall &gt; JSON Details &gt; Simplified JSON</a> object.
       <br>Multiple lines are concatenated with newlines.
    <li>
       Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.RestSvlVariables'>Overview &gt; juneau-rest-server &gt; SVL Variables</a>
       (e.g. <js>"$L{my.localized.variable}"</js>).
  </ul></div>
 <dl>
 <dt>Default:</dt>
 <dd>-1L</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="minp--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>minp</h4>
 <pre>public abstract&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.440">minp</a></pre>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#minProperties--"><code>minProperties()</code></a>.</div>
 <dl>
 <dt>Default:</dt>
 <dd>-1L</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;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.474">required</a></pre>
 <div class="block"><mk>required</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.

  <p>
    Determines whether this parameter is mandatory.
   <br>The property MAY be included and its default value is false.

  <h5 class='section'>Examples:</h5>
  <p class='bcode w800'>
    <jc>// Used on parameter</jc>
    <ja>@RestMethod</ja>(name=<jsf>POST</jsf>)
    <jk>public void</jk> addPet(
       <ja>@Body</ja>(required=<jk>true</jk>) Pet input
    ) {...}
  </p>
  <p class='bcode w800'>
    <jc>// Used on class</jc>
    <ja>@RestMethod</ja>(name=<jsf>POST</jsf>)
    <jk>public void</jk> addPet(Pet input) {...}

    <ja>@Body</ja>(required=<jk>true</jk>)
    <jk>public class</jk> Pet {...}
  </p>

  <ul class='notes'>
    <li>
       The format is boolean.
    <li>
       Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.RestSvlVariables'>Overview &gt; juneau-rest-server &gt; SVL Variables</a>
       (e.g. <js>"$L{my.localized.variable}"</js>).
  </ul></div>
 <dl>
 <dt>Default:</dt>
 <dd>false</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="r--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>r</h4>
 <pre>public abstract&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.479">r</a></pre>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#required--"><code>required()</code></a>.</div>
 <dl>
 <dt>Default:</dt>
 <dd>false</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="Z:Z_enum--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>_enum</h4>
 <pre>public abstract&nbsp;<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>[]&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.493">_enum</a></pre>
 <div class="block"><mk>enum</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.

  <ul class='notes'>
    <li>
       The format is a <a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.JsonDetails.SimplifiedJson'>Overview &gt; juneau-marshall &gt; JSON Details &gt; Simplified JSON</a> array or comma-delimited list.
       <br>Multiple lines are concatenated with newlines.
    <li>
       Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.RestSvlVariables'>Overview &gt; juneau-rest-server &gt; SVL Variables</a>
       (e.g. <js>"$L{my.localized.variable}"</js>).
  </ul></div>
 <dl>
 <dt>Default:</dt>
 <dd>{}</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="e--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>e</h4>
 <pre>public abstract&nbsp;<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>[]&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.498">e</a></pre>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#Z:Z_enum--"><code>_enum()</code></a>.</div>
 <dl>
 <dt>Default:</dt>
 <dd>{}</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="type--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>type</h4>
 <pre>public abstract&nbsp;<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>&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.544">type</a></pre>
 <div class="block"><mk>type</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.

  <h5 class='section'>Examples:</h5>
  <p class='bcode w800'>
    <jc>// Used on parameter</jc>
    <ja>@RestMethod</ja>(name=<jsf>POST</jsf>)
    <jk>public void</jk> addPet(
       <ja>@Body</ja>(type=<js>"object"</js>) Pet input
    ) {...}
  </p>
  <p class='bcode w800'>
    <jc>// Used on class</jc>
    <ja>@RestMethod</ja>(name=<jsf>POST</jsf>)
    <jk>public void</jk> addPet(Pet input) {...}

    <ja>@Body</ja>(type=<js>"object"</js>)
    <jk>public class</jk> Pet {...}
  </p>

  <ul class='notes'>
    <li>
       The format is plain text.
    <li>
       The possible values are:
       <ul>
          <li><js>"object"</js>
          <li><js>"string"</js>
          <li><js>"number"</js>
          <li><js>"integer"</js>
          <li><js>"boolean"</js>
          <li><js>"array"</js>
          <li><js>"file"</js>
       </ul>
    <li>
       Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.RestSvlVariables'>Overview &gt; juneau-rest-server &gt; SVL Variables</a>
       (e.g. <js>"$L{my.localized.variable}"</js>).
  </ul>

  <ul class='seealso'>
    <li class='extlink'><a class='doclink' href='https://swagger.io/specification#dataTypes'>Swagger Data Types</a>
  </ul></div>
 <dl>
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="t--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>t</h4>
 <pre>public abstract&nbsp;<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>&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.549">t</a></pre>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#type--"><code>type()</code></a>.</div>
 <dl>
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="items--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>items</h4>
 <pre>public abstract&nbsp;<a href="../../../../../org/apache/juneau/jsonschema/annotation/Items.html" title="annotation in org.apache.juneau.jsonschema.annotation">Items</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.563">items</a></pre>
 <div class="block"><mk>items</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.

  <ul class='notes'>
    <li>
       The format is a <a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.JsonDetails.SimplifiedJson'>Overview &gt; juneau-marshall &gt; JSON Details &gt; Simplified JSON</a> object.
       <br>Multiple lines are concatenated with newlines.
    <li>
       Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.RestSvlVariables'>Overview &gt; juneau-rest-server &gt; SVL Variables</a>
       (e.g. <js>"$L{my.localized.variable}"</js>).
  </ul></div>
 <dl>
 <dt>Default:</dt>
 <dd>@org.apache.juneau.jsonschema.annotation.Items</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="collectionFormat--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>collectionFormat</h4>
 <pre>public abstract&nbsp;<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>&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.608">collectionFormat</a></pre>
 <div class="block"><mk>collectionFormat</mk> field.

  <p>
  Note that this field isn't part of the Swagger 2.0 specification, but the specification does not specify how
  items are supposed to be represented.

  <p>
  Determines the format of the array if <c>type</c> <js>"array"</js> is used.
  <br>Can only be used if <c>type</c> is <js>"array"</js>.

  <br>Possible values are:
  <ul class='spaced-list'>
    <li>
       <js>"csv"</js> (default) - Comma-separated values (e.g. <js>"foo,bar"</js>).
    <li>
       <js>"ssv"</js> - Space-separated values (e.g. <js>"foo bar"</js>).
    <li>
       <js>"tsv"</js> - Tab-separated values (e.g. <js>"foo\tbar"</js>).
    <li>
       <js>"pipes</js> - Pipe-separated values (e.g. <js>"foo|bar"</js>).
    <li>
       <js>"multi"</js> - Corresponds to multiple parameter instances instead of multiple values for a single instance (e.g. <js>"foo=bar&amp;foo=baz"</js>).
    <li>
       <js>"uon"</js> - UON notation (e.g. <js>"@(foo,bar)"</js>).
  </ul>

  <p>
  Static strings are defined in <a href="../../../../../org/apache/juneau/http/annotation/CollectionFormatType.html" title="class in org.apache.juneau.http.annotation"><code>CollectionFormatType</code></a>.

  <p>
  Note that for collections/arrays parameters with POJO element types, the input is broken into a string array before being converted into POJO elements.

  <h5 class='section'>Used for:</h5>
  <ul class='spaced-list'>
    <li>
       Server-side schema-based parsing.
    <li>
       Server-side generated Swagger documentation.
    <li>
       Client-side schema-based serializing.
  </ul></div>
 <dl>
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="cf--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>cf</h4>
 <pre>public abstract&nbsp;<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>&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.613">cf</a></pre>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#collectionFormat--"><code>collectionFormat()</code></a>.</div>
 <dl>
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="allOf--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>allOf</h4>
 <pre>public abstract&nbsp;<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>[]&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.627">allOf</a></pre>
 <div class="block"><mk>allOf</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.

  <ul class='notes'>
    <li>
       The format is a <a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.JsonDetails.SimplifiedJson'>Overview &gt; juneau-marshall &gt; JSON Details &gt; Simplified JSON</a> object.
       <br>Multiple lines are concatenated with newlines.
    <li>
       Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.RestSvlVariables'>Overview &gt; juneau-rest-server &gt; SVL Variables</a>
       (e.g. <js>"$L{my.localized.variable}"</js>).
  </ul></div>
 <dl>
 <dt>Default:</dt>
 <dd>{}</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="properties--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>properties</h4>
 <pre>public abstract&nbsp;<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>[]&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.641">properties</a></pre>
 <div class="block"><mk>properties</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.

  <ul class='notes'>
    <li>
       The format is a <a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.JsonDetails.SimplifiedJson'>Overview &gt; juneau-marshall &gt; JSON Details &gt; Simplified JSON</a> object.
       <br>Multiple lines are concatenated with newlines.
    <li>
       Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.RestSvlVariables'>Overview &gt; juneau-rest-server &gt; SVL Variables</a>
       (e.g. <js>"$L{my.localized.variable}"</js>).
  </ul></div>
 <dl>
 <dt>Default:</dt>
 <dd>{}</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="additionalProperties--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>additionalProperties</h4>
 <pre>public abstract&nbsp;<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>[]&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.655">additionalProperties</a></pre>
 <div class="block"><mk>additionalProperties</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.

  <ul class='notes'>
    <li>
       The format is a <a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.JsonDetails.SimplifiedJson'>Overview &gt; juneau-marshall &gt; JSON Details &gt; Simplified JSON</a> object.
       <br>Multiple lines are concatenated with newlines.
    <li>
       Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.RestSvlVariables'>Overview &gt; juneau-rest-server &gt; SVL Variables</a>
       (e.g. <js>"$L{my.localized.variable}"</js>).
  </ul></div>
 <dl>
 <dt>Default:</dt>
 <dd>{}</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="discriminator--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>discriminator</h4>
 <pre>public abstract&nbsp;<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>&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.669">discriminator</a></pre>
 <div class="block"><mk>discriminator</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.

  <ul class='notes'>
    <li>
       The format is a <a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.JsonDetails.SimplifiedJson'>Overview &gt; juneau-marshall &gt; JSON Details &gt; Simplified JSON</a> object.
       <br>Multiple lines are concatenated with newlines.
    <li>
       Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.RestSvlVariables'>Overview &gt; juneau-rest-server &gt; SVL Variables</a>
       (e.g. <js>"$L{my.localized.variable}"</js>).
  </ul></div>
 <dl>
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="readOnly--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>readOnly</h4>
 <pre>public abstract&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.683">readOnly</a></pre>
 <div class="block"><mk>readOnly</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.

  <ul class='notes'>
    <li>
       The format is a <a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.JsonDetails.SimplifiedJson'>Overview &gt; juneau-marshall &gt; JSON Details &gt; Simplified JSON</a> object.
       <br>Multiple lines are concatenated with newlines.
    <li>
       Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.RestSvlVariables'>Overview &gt; juneau-rest-server &gt; SVL Variables</a>
       (e.g. <js>"$L{my.localized.variable}"</js>).
  </ul></div>
 <dl>
 <dt>Default:</dt>
 <dd>false</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="ro--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>ro</h4>
 <pre>public abstract&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.688">ro</a></pre>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#readOnly--"><code>readOnly()</code></a>.</div>
 <dl>
 <dt>Default:</dt>
 <dd>false</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="xml--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>xml</h4>
 <pre>public abstract&nbsp;<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>[]&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.702">xml</a></pre>
 <div class="block"><mk>xml</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.

  <ul class='notes'>
    <li>
       The format is a <a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.JsonDetails.SimplifiedJson'>Overview &gt; juneau-marshall &gt; JSON Details &gt; Simplified JSON</a> object.
       <br>Multiple lines are concatenated with newlines.
    <li>
       Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.RestSvlVariables'>Overview &gt; juneau-rest-server &gt; SVL Variables</a>
       (e.g. <js>"$L{my.localized.variable}"</js>).
  </ul></div>
 <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&nbsp;<a href="../../../../../org/apache/juneau/jsonschema/annotation/ExternalDocs.html" title="annotation in org.apache.juneau.jsonschema.annotation">ExternalDocs</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.716">externalDocs</a></pre>
 <div class="block"><mk>externalDocs</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.

  <ul class='notes'>
    <li>
       The format is a <a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.JsonDetails.SimplifiedJson'>Overview &gt; juneau-marshall &gt; JSON Details &gt; Simplified JSON</a> object.
       <br>Multiple lines are concatenated with newlines.
    <li>
       Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.RestSvlVariables'>Overview &gt; juneau-rest-server &gt; SVL Variables</a>
       (e.g. <js>"$L{my.localized.variable}"</js>).
  </ul></div>
 <dl>
 <dt>Default:</dt>
 <dd>@org.apache.juneau.jsonschema.annotation.ExternalDocs</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;<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>[]&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.737">example</a></pre>
 <div class="block"><mk>example</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.

  <p>
  A free-form property to include an example of an instance for this schema.

  <p>
  This attribute defines a JSON representation of the body value that is used by <c>BasicRestInfoProvider</c> to construct
  media-type-based examples of the body of the request.

  <ul class='notes'>
    <li>
       The format is a <a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.JsonDetails.SimplifiedJson'>Overview &gt; juneau-marshall &gt; JSON Details &gt; Simplified JSON</a> object or plain text string.
       <br>Multiple lines are concatenated with newlines.
    <li>
       Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.RestSvlVariables'>Overview &gt; juneau-rest-server &gt; SVL Variables</a>
       (e.g. <js>"$L{my.localized.variable}"</js>).
  </ul></div>
 <dl>
 <dt>Default:</dt>
 <dd>{}</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="ex--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>ex</h4>
 <pre>public abstract&nbsp;<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>[]&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.742">ex</a></pre>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#readOnly--"><code>readOnly()</code></a>.</div>
 <dl>
 <dt>Default:</dt>
 <dd>{}</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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.759">examples</a></pre>
 <div class="block"><mk>x-examples</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.

  <p>
  This is a JSON object whose keys are media types and values are string representations of that value.

  <ul class='notes'>
    <li>
       The format is a <a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.JsonDetails.SimplifiedJson'>Overview &gt; juneau-marshall &gt; JSON Details &gt; Simplified JSON</a> object.
       <br>Multiple lines are concatenated with newlines.
    <li>
       Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.RestSvlVariables'>Overview &gt; juneau-rest-server &gt; SVL Variables</a>
       (e.g. <js>"$L{my.localized.variable}"</js>).
  </ul></div>
 <dl>
 <dt>Default:</dt>
 <dd>{}</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="exs--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>exs</h4>
 <pre>public abstract&nbsp;<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>[]&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.764">exs</a></pre>
 <div class="block">Synonym for <a href="../../../../../org/apache/juneau/jsonschema/annotation/Schema.html#examples--"><code>examples()</code></a>.</div>
 <dl>
 <dt>Default:</dt>
 <dd>{}</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="ignore--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>ignore</h4>
 <pre>public abstract&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.769">ignore</a></pre>
 <div class="block">Specifies that schema information for this part should not be shown in the generated Swagger documentation.</div>
 <dl>
 <dt>Default:</dt>
 <dd>false</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="value--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>value</h4>
 <pre>public abstract&nbsp;<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>[]&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.829">value</a></pre>
 <div class="block">Free-form value for the <a class='doclink' href='https://swagger.io/specification/v2#schemaObject'>Swagger Schema Object</a>.

  <p>
  This is a JSON object that makes up the swagger information for this field.

  <p>
  The following are completely equivalent ways of defining the swagger description of a Schema object:
  <p class='bcode w800'>
    <jc>// Normal</jc>
    <ja>@Schema</ja>(
       type=<js>"array"</js>,
       items=<ja>@Items</ja>(
          $ref=<js>"#/definitions/Pet"</js>
       )
    )
  </p>
  <p class='bcode w800'>
    <jc>// Free-form</jc>
    <ja>@Schema</ja>(<js>"type:'array',items:{$ref:'#/definitions/Pet'}"</js>)
  </p>
  <p class='bcode w800'>
    <jc>// Free-form using variables</jc>
    <ja>@Schema</ja>(<js>"$L{petArraySwagger}"</js>)
  </p>
  <p class='bcode w800'>
    <mc>// Contents of MyResource.properties</mc>
    <mk>petArraySwagger</mk> = <mv>{ type: "array", items: { $ref: "#/definitions/Pet" } }</mv>
  </p>

  <p>
    The reasons why you may want to use this field include:
  <ul>
    <li>You want to pull in the entire Swagger JSON definition for this field from an external source such as a properties file.
    <li>You want to add extra fields to the Swagger documentation that are not officially part of the Swagger specification.
  </ul>

  <ul class='notes'>
    <li>
       The format is a <a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.JsonDetails.SimplifiedJson'>Overview &gt; juneau-marshall &gt; JSON Details &gt; Simplified JSON</a> object.
    <li>
       The leading/trailing <c>{ }</c> characters are optional.
       <br>The following two example are considered equivalent:
       <p class='bcode w800'>
    <ja>@Schema</ja>(<js>"{type: 'array'}"</js>)
       </p>
       <p class='bcode w800'>
    <ja>@Schema</ja>(<js>"type: 'array'"</js>)
       </p>
    <li>
       Multiple lines are concatenated with newlines so that you can format the value to be readable.
    <li>
       Supports <a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.RestSvlVariables'>Overview &gt; juneau-rest-server &gt; SVL Variables</a>
       (e.g. <js>"$L{my.localized.variable}"</js>).
    <li>
       Values defined in this field supersede values pulled from the Swagger JSON file and are superseded by individual values defined on this annotation.
  </ul></div>
 <dl>
 <dt>Default:</dt>
 <dd>{}</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="on--">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>on</h4>
 <pre>public abstract&nbsp;<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>&nbsp;<a href="../../../../../src-html/org/apache/juneau/jsonschema/annotation/Schema.html#line.914">on</a></pre>
 <div class="block">Dynamically apply this annotation to the specified classes/methods/fields.

  <p>
  Used in conjunction with the <a href="../../../../../org/apache/juneau/jsonschema/annotation/JsonSchemaConfig.html#applySchema--"><code>JsonSchemaConfig.applySchema()</code></a>.
  It is ignored when the annotation is applied directly to classes/methods/fields.

  <h5 class='section'>Valid patterns:</h5>
  <ul class='spaced-list'>
   <li>Classes:
       <ul>
          <li>Fully qualified:
             <ul>
                <li><js>"com.foo.MyClass"</js>
             </ul>
          <li>Fully qualified inner class:
             <ul>
                <li><js>"com.foo.MyClass$Inner1$Inner2"</js>
             </ul>
          <li>Simple:
             <ul>
                <li><js>"MyClass"</js>
             </ul>
          <li>Simple inner:
             <ul>
                <li><js>"MyClass$Inner1$Inner2"</js>
                <li><js>"Inner1$Inner2"</js>
                <li><js>"Inner2"</js>
             </ul>
       </ul>
    <li>Methods:
       <ul>
          <li>Fully qualified with args:
             <ul>
                <li><js>"com.foo.MyClass.myMethod(String,int)"</js>
                <li><js>"com.foo.MyClass.myMethod(java.lang.String,int)"</js>
                <li><js>"com.foo.MyClass.myMethod()"</js>
             </ul>
          <li>Fully qualified:
             <ul>
                <li><js>"com.foo.MyClass.myMethod"</js>
             </ul>
          <li>Simple with args:
             <ul>
                <li><js>"MyClass.myMethod(String,int)"</js>
                <li><js>"MyClass.myMethod(java.lang.String,int)"</js>
                <li><js>"MyClass.myMethod()"</js>
             </ul>
          <li>Simple:
             <ul>
                <li><js>"MyClass.myMethod"</js>
             </ul>
          <li>Simple inner class:
             <ul>
                <li><js>"MyClass$Inner1$Inner2.myMethod"</js>
                <li><js>"Inner1$Inner2.myMethod"</js>
                <li><js>"Inner2.myMethod"</js>
             </ul>
       </ul>
    <li>Fields:
       <ul>
          <li>Fully qualified:
             <ul>
                <li><js>"com.foo.MyClass.myField"</js>
             </ul>
          <li>Simple:
             <ul>
                <li><js>"MyClass.myField"</js>
             </ul>
          <li>Simple inner class:
             <ul>
                <li><js>"MyClass$Inner1$Inner2.myField"</js>
                <li><js>"Inner1$Inner2.myField"</js>
                <li><js>"Inner2.myField"</js>
             </ul>
       </ul>
    <li>A comma-delimited list of anything on this list.
  </ul>

  <ul class='seealso'>
    <li class='link'><a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.DynamicallyAppliedAnnotations'>Overview &gt; juneau-marshall &gt; Dynamically Applied Annotations</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/jsonschema/annotation/JsonSchemaConfigApply.html" title="class in org.apache.juneau.jsonschema.annotation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../../org/apache/juneau/jsonschema/annotation/SchemaAnnotation.html" title="class in org.apache.juneau.jsonschema.annotation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../index.html?org/apache/juneau/jsonschema/annotation/Schema.html" target="_top">Frames</a></li>
 <li><a href="Schema.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 ======= -->
 <p class="legalCopy"><small>Copyright &#169; 2016&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </body>
 </html>