You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2018/01/14 23:07:15 UTC
[32/51] [partial] juneau-website git commit: Update javadocs.
http://git-wip-us.apache.org/repos/asf/juneau-website/blob/c319662c/content/site/apidocs/org/apache/juneau/dto/swagger/Items.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/dto/swagger/Items.html b/content/site/apidocs/org/apache/juneau/dto/swagger/Items.html
index 8b9a0ff..eea0b98 100644
--- a/content/site/apidocs/org/apache/juneau/dto/swagger/Items.html
+++ b/content/site/apidocs/org/apache/juneau/dto/swagger/Items.html
@@ -117,7 +117,7 @@ var activeTableTab = "activeTableTab";
public class <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.51">Items</a>
extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.html" title="class in org.apache.juneau.dto.swagger">SwaggerElement</a></pre>
<div class="block">A limited subset of JSON-Schema's items object. It is used by parameter definitions that are not located in "body".
-
+
<h5 class='section'>Example:</h5>
<p class='bcode'>
{
@@ -125,7 +125,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<js>"minLength"</js>: 2
}
</p>
-
+
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
<li class='link'>
@@ -564,7 +564,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>getType</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.90">getType</a>()</pre>
<div class="block">Bean property getter: <property>type</property>.
-
+
<p>
Required. The internal type of the array.
The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>, or
@@ -583,7 +583,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>setType</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Items.html" title="class in org.apache.juneau.dto.swagger">Items</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.105">setType</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type)</pre>
<div class="block">Bean property setter: <property>type</property>.
-
+
<p>
Required. The internal type of the array.
The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>, or
@@ -620,7 +620,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>getFormat</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.133">getFormat</a>()</pre>
<div class="block">Bean property getter: <property>format</property>.
-
+
<p>
The extending format for the previously mentioned <code>type</code>. See <a class="doclink"
href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further details.</div>
@@ -638,7 +638,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>setFormat</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Items.html" title="class in org.apache.juneau.dto.swagger">Items</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.147">setFormat</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> format)</pre>
<div class="block">Bean property setter: <property>format</property>.
-
+
<p>
The extending format for the previously mentioned <code>type</code>. See <a class="doclink"
href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further details.</div>
@@ -674,7 +674,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>getItems</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Items.html" title="class in org.apache.juneau.dto.swagger">Items</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.171">getItems</a>()</pre>
<div class="block">Bean property getter: <property>items</property>.
-
+
<p>
Required if <code>type</code> is <js>"array"</js>.
Describes the type of items in the array.</div>
@@ -692,7 +692,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>setItems</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Items.html" title="class in org.apache.juneau.dto.swagger">Items</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.185">setItems</a>(<a href="../../../../../org/apache/juneau/dto/swagger/Items.html" title="class in org.apache.juneau.dto.swagger">Items</a> items)</pre>
<div class="block">Bean property setter: <property>items</property>.
-
+
<p>
Required if <code>type</code> is <js>"array"</js>.
Describes the type of items in the array.</div>
@@ -728,10 +728,10 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>getCollectionFormat</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.222">getCollectionFormat</a>()</pre>
<div class="block">Bean property getter: <property>collectionFormat</property>.
-
+
<p>
Determines the format of the array if type array is used.
-
+
<p>
Possible values are:
<ul>
@@ -740,7 +740,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<li><code>tsv</code> - tab separated values <code>foo\tbar</code>.
<li><code>pipes</code> - pipe separated values <code>foo|bar</code>.
</ul>
-
+
<p>
Default value is <code>csv</code>.</div>
<dl>
@@ -758,10 +758,10 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>setCollectionFormat</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Items.html" title="class in org.apache.juneau.dto.swagger">Items</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.247">setCollectionFormat</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> collectionFormat)</pre>
<div class="block">Bean property setter: <property>collectionFormat</property>.
-
+
<p>
Determines the format of the array if type array is used.
-
+
<p>
Possible values are:
<ul>
@@ -770,7 +770,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<li><code>tsv</code> - tab separated values <code>foo\tbar</code>.
<li><code>pipes</code> - pipe separated values <code>foo|bar</code>.
</ul>
-
+
<p>
Default value is <code>csv</code>.</div>
<dl>
@@ -805,7 +805,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>getDefault</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.279">getDefault</a>()</pre>
<div class="block">Bean property getter: <property>default</property>.
-
+
<p>
Declares the value of the item that the server will use if none is provided.
(Note: <js>"default"</js> has no meaning for required items.)
@@ -826,7 +826,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>setDefault</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Items.html" title="class in org.apache.juneau.dto.swagger">Items</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.296">setDefault</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> _default)</pre>
<div class="block">Bean property setter: <property>default</property>.
-
+
<p>
Declares the value of the item that the server will use if none is provided.
(Note: <js>"default"</js> has no meaning for required items.)
@@ -865,7 +865,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>getMaximum</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.320">getMaximum</a>()</pre>
<div class="block">Bean property getter: <property>maximum</property>.
-
+
<p>
See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">
http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.</div>
@@ -883,7 +883,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>setMaximum</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Items.html" title="class in org.apache.juneau.dto.swagger">Items</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.334">setMaximum</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a> maximum)</pre>
<div class="block">Bean property setter: <property>maximum</property>.
-
+
<p>
See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">
http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.</div>
@@ -919,7 +919,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>getExclusiveMaximum</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.360">getExclusiveMaximum</a>()</pre>
<div class="block">Bean property getter: <property>exclusiveMaximum</property>.
-
+
<p>
See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">
http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.</div>
@@ -938,7 +938,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>setExclusiveMaximum</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Items.html" title="class in org.apache.juneau.dto.swagger">Items</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.374">setExclusiveMaximum</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> exclusiveMaximum)</pre>
<div class="block">Bean property setter: <property>exclusiveMaximum</property>.
-
+
<p>
See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">
http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.</div>
@@ -974,7 +974,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>getMinimum</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.398">getMinimum</a>()</pre>
<div class="block">Bean property getter: <property>minimum</property>.
-
+
<p>
See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">
http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.</div>
@@ -992,7 +992,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>setMinimum</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Items.html" title="class in org.apache.juneau.dto.swagger">Items</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.412">setMinimum</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a> minimum)</pre>
<div class="block">Bean property setter: <property>minimum</property>.
-
+
<p>
See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">
http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.</div>
@@ -1028,7 +1028,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>getExclusiveMinimum</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.437">getExclusiveMinimum</a>()</pre>
<div class="block">Bean property getter: <property>exclusiveMinimum</property>.
-
+
<p>
See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">
http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.</div>
@@ -1047,7 +1047,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>setExclusiveMinimum</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Items.html" title="class in org.apache.juneau.dto.swagger">Items</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.451">setExclusiveMinimum</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> exclusiveMinimum)</pre>
<div class="block">Bean property setter: <property>exclusiveMinimum</property>.
-
+
<p>
See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">
http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.</div>
@@ -1083,7 +1083,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>getMaxLength</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.475">getMaxLength</a>()</pre>
<div class="block">Bean property getter: <property>maxLength</property>.
-
+
<p>
See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor26">
http://json-schema.org/latest/json-schema-validation.html#anchor26</a>.</div>
@@ -1101,7 +1101,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>setMaxLength</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Items.html" title="class in org.apache.juneau.dto.swagger">Items</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.489">setMaxLength</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> maxLength)</pre>
<div class="block">Bean property setter: <property>maxLength</property>.
-
+
<p>
See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor26">
http://json-schema.org/latest/json-schema-validation.html#anchor26</a>.</div>
@@ -1137,7 +1137,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>getMinLength</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.513">getMinLength</a>()</pre>
<div class="block">Bean property getter: <property>minLength</property>.
-
+
<p>
See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor29">
http://json-schema.org/latest/json-schema-validation.html#anchor29</a>.</div>
@@ -1155,7 +1155,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>setMinLength</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Items.html" title="class in org.apache.juneau.dto.swagger">Items</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.527">setMinLength</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> minLength)</pre>
<div class="block">Bean property setter: <property>minLength</property>.
-
+
<p>
See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor29">
http://json-schema.org/latest/json-schema-validation.html#anchor29</a>.</div>
@@ -1191,7 +1191,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>getPattern</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.551">getPattern</a>()</pre>
<div class="block">Bean property getter: <property>pattern</property>.
-
+
<p>
See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor33">
http://json-schema.org/latest/json-schema-validation.html#anchor33</a>.</div>
@@ -1209,7 +1209,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>setPattern</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Items.html" title="class in org.apache.juneau.dto.swagger">Items</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.565">setPattern</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> pattern)</pre>
<div class="block">Bean property setter: <property>pattern</property>.
-
+
<p>
See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor33">
http://json-schema.org/latest/json-schema-validation.html#anchor33</a>.</div>
@@ -1245,7 +1245,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>getMaxItems</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.589">getMaxItems</a>()</pre>
<div class="block">Bean property getter: <property>maxItems</property>.
-
+
<p>
See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor42">
http://json-schema.org/latest/json-schema-validation.html#anchor42</a>.</div>
@@ -1263,7 +1263,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>setMaxItems</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Items.html" title="class in org.apache.juneau.dto.swagger">Items</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.603">setMaxItems</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> maxItems)</pre>
<div class="block">Bean property setter: <property>maxItems</property>.
-
+
<p>
See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor42">
http://json-schema.org/latest/json-schema-validation.html#anchor42</a>.</div>
@@ -1299,7 +1299,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>getMinItems</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.627">getMinItems</a>()</pre>
<div class="block">Bean property getter: <property>minItems</property>.
-
+
<p>
See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor45">
http://json-schema.org/latest/json-schema-validation.html#anchor45</a>.</div>
@@ -1317,7 +1317,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>setMinItems</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Items.html" title="class in org.apache.juneau.dto.swagger">Items</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.641">setMinItems</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> minItems)</pre>
<div class="block">Bean property setter: <property>minItems</property>.
-
+
<p>
See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor45">
http://json-schema.org/latest/json-schema-validation.html#anchor45</a>.</div>
@@ -1353,7 +1353,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>getUniqueItems</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.666">getUniqueItems</a>()</pre>
<div class="block">Bean property getter: <property>uniqueItems</property>.
-
+
<p>
See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor49">
http://json-schema.org/latest/json-schema-validation.html#anchor49</a>.</div>
@@ -1372,7 +1372,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>setUniqueItems</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Items.html" title="class in org.apache.juneau.dto.swagger">Items</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.680">setUniqueItems</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> uniqueItems)</pre>
<div class="block">Bean property setter: <property>uniqueItems</property>.
-
+
<p>
See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor49">
http://json-schema.org/latest/json-schema-validation.html#anchor49</a>.</div>
@@ -1408,7 +1408,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>getEnum</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.704">getEnum</a>()</pre>
<div class="block">Bean property getter: <property>enum</property>.
-
+
<p>
See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">
http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.</div>
@@ -1426,7 +1426,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>setEnum</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Items.html" title="class in org.apache.juneau.dto.swagger">Items</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.718">setEnum</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> _enum)</pre>
<div class="block">Bean property setter: <property>enum</property>.
-
+
<p>
See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">
http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.</div>
@@ -1446,7 +1446,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>addEnum</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Items.html" title="class in org.apache.juneau.dto.swagger">Items</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.735">addEnum</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... _enum)</pre>
<div class="block">Bean property adder: <property>enum</property>.
-
+
<p>
See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">
http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.</div>
@@ -1484,7 +1484,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>getMultipleOf</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.771">getMultipleOf</a>()</pre>
<div class="block">Bean property getter: <property>multipleOf</property>.
-
+
<p>
See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor14">
http://json-schema.org/latest/json-schema-validation.html#anchor14</a>.</div>
@@ -1502,7 +1502,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>setMultipleOf</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Items.html" title="class in org.apache.juneau.dto.swagger">Items</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Items.html#line.785">setMultipleOf</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a> multipleOf)</pre>
<div class="block">Bean property setter: <property>multipleOf</property>.
-
+
<p>
See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor14">
http://json-schema.org/latest/json-schema-validation.html#anchor14</a>.</div>
http://git-wip-us.apache.org/repos/asf/juneau-website/blob/c319662c/content/site/apidocs/org/apache/juneau/dto/swagger/License.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/dto/swagger/License.html b/content/site/apidocs/org/apache/juneau/dto/swagger/License.html
index 90ac1a1..84f2504 100644
--- a/content/site/apidocs/org/apache/juneau/dto/swagger/License.html
+++ b/content/site/apidocs/org/apache/juneau/dto/swagger/License.html
@@ -117,7 +117,7 @@ var activeTableTab = "activeTableTab";
public class <a href="../../../../../src-html/org/apache/juneau/dto/swagger/License.html#line.50">License</a>
extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.html" title="class in org.apache.juneau.dto.swagger">SwaggerElement</a></pre>
<div class="block">License information for the exposed API.
-
+
<h5 class='section'>Example:</h5>
<p class='bcode'>
{
@@ -125,7 +125,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<js>"url"</js>: <js>"http://www.apache.org/licenses/LICENSE-2.0.html"</js>
}
</p>
-
+
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
<li class='link'>
@@ -265,7 +265,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>getName</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/License.html#line.63">getName</a>()</pre>
<div class="block">Bean property getter: <property>name</property>.
-
+
<p>
Required. The license name used for the API.</div>
<dl>
@@ -282,7 +282,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>setName</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/License.html" title="class in org.apache.juneau.dto.swagger">License</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/License.html#line.76">setName</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre>
<div class="block">Bean property setter: <property>name</property>.
-
+
<p>
Required. The license name used for the API.</div>
<dl>
@@ -317,14 +317,14 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>getUrl</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/License.html#line.106">getUrl</a>()</pre>
<div class="block">Bean property getter: <property>url</property>.
-
+
<p>
A URL to the license used for the API.
-
+
<p>
The value can be of any of the following types: <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net"><code>URL</code></a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a>.
Strings must be valid URIs.
-
+
<p>
URIs defined by <a href="../../../../../org/apache/juneau/UriResolver.html" title="class in org.apache.juneau"><code>UriResolver</code></a> can be used for values.</div>
<dl>
@@ -341,11 +341,11 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>setUrl</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/License.html" title="class in org.apache.juneau.dto.swagger">License</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/License.html#line.123">setUrl</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> url)</pre>
<div class="block">Bean property setter: <property>url</property>.
-
+
<p>
The value can be of any of the following types: <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net"><code>URL</code></a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a>.
Strings must be valid URIs.
-
+
<p>
URIs defined by <a href="../../../../../org/apache/juneau/UriResolver.html" title="class in org.apache.juneau"><code>UriResolver</code></a> can be used for values.</div>
<dl>
http://git-wip-us.apache.org/repos/asf/juneau-website/blob/c319662c/content/site/apidocs/org/apache/juneau/dto/swagger/Operation.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/dto/swagger/Operation.html b/content/site/apidocs/org/apache/juneau/dto/swagger/Operation.html
index e0081e9..528eb25 100644
--- a/content/site/apidocs/org/apache/juneau/dto/swagger/Operation.html
+++ b/content/site/apidocs/org/apache/juneau/dto/swagger/Operation.html
@@ -117,7 +117,7 @@ var activeTableTab = "activeTableTab";
public class <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.97">Operation</a>
extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.html" title="class in org.apache.juneau.dto.swagger">SwaggerElement</a></pre>
<div class="block">Describes a single API operation on a path.
-
+
<h5 class='section'>Example:</h5>
<p class='bcode'>
{
@@ -175,7 +175,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
]
}
</p>
-
+
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
<li class='link'>
@@ -594,7 +594,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>getTags</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.121">getTags</a>()</pre>
<div class="block">Bean property getter: <property>tags</property>.
-
+
<p>
A list of tags for API documentation control.
Tags can be used for logical grouping of operations by resources or any other qualifier.</div>
@@ -612,7 +612,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>setTags</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html" title="class in org.apache.juneau.dto.swagger">Operation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.135">setTags</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> tags)</pre>
<div class="block">Bean property setter: <property>tags</property>.
-
+
<p>
A list of tags for API documentation control.
Tags can be used for logical grouping of operations by resources or any other qualifier.</div>
@@ -632,7 +632,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>addTags</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html" title="class in org.apache.juneau.dto.swagger">Operation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.150">addTags</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... tags)</pre>
<div class="block">Bean property adder: <property>tags</property>.
-
+
<p>
A list of tags for API documentation control.
Tags can be used for logical grouping of operations by resources or any other qualifier.</div>
@@ -652,7 +652,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>addTags</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html" title="class in org.apache.juneau.dto.swagger">Operation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.166">addTags</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> tags)</pre>
<div class="block">Bean property adder: <property>tags</property>.
-
+
<p>
A list of tags for API documentation control.
Tags can be used for logical grouping of operations by resources or any other qualifier.</div>
@@ -705,7 +705,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>getSummary</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.204">getSummary</a>()</pre>
<div class="block">Bean property getter: <property>summary</property>.
-
+
<p>
A short summary of what the operation does.
For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.</div>
@@ -723,7 +723,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>setSummary</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html" title="class in org.apache.juneau.dto.swagger">Operation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.218">setSummary</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> summary)</pre>
<div class="block">Bean property setter: <property>summary</property>.
-
+
<p>
A short summary of what the operation does.
For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.</div>
@@ -759,7 +759,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>getDescription</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.244">getDescription</a>()</pre>
<div class="block">Bean property getter: <property>description</property>.
-
+
<p>
A verbose explanation of the operation behavior.
<a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
@@ -778,7 +778,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>setDescription</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html" title="class in org.apache.juneau.dto.swagger">Operation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.259">setDescription</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> description)</pre>
<div class="block">Bean property setter: <property>description</property>.
-
+
<p>
A verbose explanation of the operation behavior.
<a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
@@ -815,7 +815,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>getExternalDocs</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html" title="class in org.apache.juneau.dto.swagger">ExternalDocumentation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.283">getExternalDocs</a>()</pre>
<div class="block">Bean property getter: <property>externalDocs</property>.
-
+
<p>
Additional external documentation for this operation.</div>
<dl>
@@ -832,7 +832,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>setExternalDocs</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html" title="class in org.apache.juneau.dto.swagger">Operation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.296">setExternalDocs</a>(<a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html" title="class in org.apache.juneau.dto.swagger">ExternalDocumentation</a> externalDocs)</pre>
<div class="block">Bean property setter: <property>externalDocs</property>.
-
+
<p>
Additional external documentation for this operation.</div>
<dl>
@@ -867,7 +867,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>getOperationId</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.322">getOperationId</a>()</pre>
<div class="block">Bean property getter: <property>operationId</property>.
-
+
<p>
Unique string used to identify the operation. The id MUST be unique among all operations described in the API.
Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to
@@ -886,7 +886,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>setOperationId</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html" title="class in org.apache.juneau.dto.swagger">Operation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.337">setOperationId</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> operationId)</pre>
<div class="block">Bean property setter: <property>operationId</property>.
-
+
<p>
Unique string used to identify the operation. The id MUST be unique among all operations described in the API.
Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to
@@ -923,7 +923,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>getConsumes</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a>> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.363">getConsumes</a>()</pre>
<div class="block">Bean property getter: <property>consumes</property>.
-
+
<p>
A list of MIME types the operation can consume.
This overrides the <code>consumes</code> definition at the Swagger Object.
@@ -943,7 +943,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>setConsumes</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html" title="class in org.apache.juneau.dto.swagger">Operation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.379">setConsumes</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a>> consumes)</pre>
<div class="block">Bean property setter: <property>consumes</property>.
-
+
<p>
A list of MIME types the operation can consume.
This overrides the <code>consumes</code> definition at the Swagger Object.
@@ -965,7 +965,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>addConsumes</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html" title="class in org.apache.juneau.dto.swagger">Operation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.396">addConsumes</a>(<a href="../../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a>... consumes)</pre>
<div class="block">Bean property adder: <property>consumes</property>.
-
+
<p>
A list of MIME types the operation can consume.
This overrides the <code>consumes</code> definition at the Swagger Object.
@@ -987,7 +987,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>addConsumes</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html" title="class in org.apache.juneau.dto.swagger">Operation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.412">addConsumes</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a>> consumes)</pre>
<div class="block">Bean property adder: <property>consumes</property>.
-
+
<p>
A list of MIME types the operation can consume.
This overrides the <code>consumes</code> definition at the Swagger Object.
@@ -1041,7 +1041,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>getProduces</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a>> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.452">getProduces</a>()</pre>
<div class="block">Bean property getter: <property>produces</property>.
-
+
<p>
A list of MIME types the operation can produce.
This overrides the <code>produces</code> definition at the Swagger Object.
@@ -1061,7 +1061,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>setProduces</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html" title="class in org.apache.juneau.dto.swagger">Operation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.468">setProduces</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a>> produces)</pre>
<div class="block">Bean property setter: <property>produces</property>.
-
+
<p>
A list of MIME types the operation can produce.
This overrides the <code>produces</code> definition at the Swagger Object.
@@ -1083,7 +1083,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>addProduces</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html" title="class in org.apache.juneau.dto.swagger">Operation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.485">addProduces</a>(<a href="../../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a>... produces)</pre>
<div class="block">Bean property adder: <property>produces</property>.
-
+
<p>
A list of MIME types the operation can produce.
This overrides the <code>produces</code> definition at the Swagger Object.
@@ -1105,7 +1105,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>addProduces</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html" title="class in org.apache.juneau.dto.swagger">Operation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.506">addProduces</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a>> produces)</pre>
<div class="block">Bean property adder: <property>produces</property>.
-
+
<p>
A list of MIME types the operation can produces.
This overrides the <code>produces</code> definition at the Swagger Object.
@@ -1159,7 +1159,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>getParameters</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a>> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.551">getParameters</a>()</pre>
<div class="block">Bean property getter: <property>parameters</property>.
-
+
<p>
A list of parameters that are applicable for this operation.
If a parameter is already defined at the <a class="doclink"
@@ -1184,7 +1184,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>setParameters</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html" title="class in org.apache.juneau.dto.swagger">Operation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.574">setParameters</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a>> parameters)</pre>
<div class="block">Bean property setter: <property>parameters</property>.
-
+
<p>
A list of parameters that are applicable for this operation.
If a parameter is already defined at the <a class="doclink"
@@ -1213,7 +1213,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>addParameters</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html" title="class in org.apache.juneau.dto.swagger">Operation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.598">addParameters</a>(<a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a>... parameters)</pre>
<div class="block">Bean property adder: <property>parameters</property>.
-
+
<p>
A list of parameters that are applicable for this operation.
If a parameter is already defined at the <a class="doclink"
@@ -1274,7 +1274,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>getResponses</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>,<a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a>> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.633">getResponses</a>()</pre>
<div class="block">Bean property getter: <property>responses</property>.
-
+
<p>
Required. The list of possible responses as they are returned from executing this operation.</div>
<dl>
@@ -1291,7 +1291,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>setResponses</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html" title="class in org.apache.juneau.dto.swagger">Operation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.646">setResponses</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>,<a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a>> responses)</pre>
<div class="block">Bean property setter: <property>responses</property>.
-
+
<p>
Required. The list of possible responses as they are returned from executing this operation.</div>
<dl>
@@ -1311,7 +1311,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html" title="class in org.apache.juneau.dto.swagger">Operation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.661">addResponse</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> statusCode,
<a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a> response)</pre>
<div class="block">Bean property adder: <property>responses</property>.
-
+
<p>
Required. The list of possible responses as they are returned from executing this operation.</div>
<dl>
@@ -1365,7 +1365,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>getSchemes</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.699">getSchemes</a>()</pre>
<div class="block">Bean property getter: <property>schemes</property>.
-
+
<p>
The transfer protocol for the operation.
Values MUST be from the list: <js>"http"</js>, <js>"https"</js>, <js>"ws"</js>, <js>"wss"</js>.
@@ -1384,7 +1384,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>setSchemes</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html" title="class in org.apache.juneau.dto.swagger">Operation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.714">setSchemes</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> schemes)</pre>
<div class="block">Bean property setter: <property>schemes</property>.
-
+
<p>
The transfer protocol for the operation.
Values MUST be from the list: <js>"http"</js>, <js>"https"</js>, <js>"ws"</js>, <js>"wss"</js>.
@@ -1405,7 +1405,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>addSchemes</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html" title="class in org.apache.juneau.dto.swagger">Operation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.730">addSchemes</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... schemes)</pre>
<div class="block">Bean property adder: <property>schemes</property>.
-
+
<p>
The transfer protocol for the operation.
Values MUST be from the list: <js>"http"</js>, <js>"https"</js>, <js>"ws"</js>, <js>"wss"</js>.
@@ -1426,7 +1426,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>addSchemes</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html" title="class in org.apache.juneau.dto.swagger">Operation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.745">addSchemes</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> schemes)</pre>
<div class="block">Bean property adder: <property>schemes</property>.
-
+
<p>
The transfer protocol for the operation.
Values MUST be from the list: <js>"http"</js>, <js>"https"</js>, <js>"ws"</js>, <js>"wss"</js>.
@@ -1463,7 +1463,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>getDeprecated</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.772">getDeprecated</a>()</pre>
<div class="block">Bean property getter: <property>deprecated</property>.
-
+
<p>
Declares this operation to be deprecated.
Usage of the declared operation should be refrained.
@@ -1482,7 +1482,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>setDeprecated</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html" title="class in org.apache.juneau.dto.swagger">Operation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.787">setDeprecated</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> deprecated)</pre>
<div class="block">Bean property setter: <property>deprecated</property>.
-
+
<p>
Declares this operation to be deprecated.
Usage of the declared operation should be refrained.
@@ -1519,7 +1519,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>getSecurity</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>>> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.814">getSecurity</a>()</pre>
<div class="block">Bean property getter: <property>security</property>.
-
+
<p>
A declaration of which security schemes are applied for this operation.
The list of values describes alternative security schemes that can be used (that is, there is a logical OR
@@ -1540,7 +1540,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>setSecurity</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html" title="class in org.apache.juneau.dto.swagger">Operation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.831">setSecurity</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>>> security)</pre>
<div class="block">Bean property setter: <property>security</property>.
-
+
<p>
A declaration of which security schemes are applied for this operation.
The list of values describes alternative security schemes that can be used (that is, there is a logical OR
@@ -1563,7 +1563,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h4>addSecurity</h4>
<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html" title="class in org.apache.juneau.dto.swagger">Operation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.849">addSecurity</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>> security)</pre>
<div class="block">Bean property adder: <property>security</property>.
-
+
<p>
A declaration of which security schemes are applied for this operation.
The list of values describes alternative security schemes that can be used (that is, there is a logical OR