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 2017/06/26 00:43:51 UTC
[07/51] [partial] incubator-juneau-website git commit: Update
javadocs.
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/89e089cf/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 972d6a9..bdcdeb7 100644
--- a/content/site/apidocs/org/apache/juneau/dto/swagger/Operation.html
+++ b/content/site/apidocs/org/apache/juneau/dto/swagger/Operation.html
@@ -114,7 +114,7 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre><a href="../../../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation">@Bean</a>(<a href="../../../../../org/apache/juneau/annotation/Bean.html#properties--">properties</a>="operationId,summary,description,tags,externalDocs,consumes,produces,parameters,responses,schemes,deprecated,security")
-public class <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.92">Operation</a>
+public class <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.93">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.
@@ -178,7 +178,8 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a>
+ <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ (org.apache.juneau.dto)</a>
<ul>
<li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
</ul>
@@ -569,7 +570,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockListLast">
<li class="blockList">
<h4>Operation</h4>
-<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.92">Operation</a>()</pre>
+<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Operation.html#line.93">Operation</a>()</pre>
</li>
</ul>
</li>
@@ -586,7 +587,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.115">getTags</a>()</pre>
+<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.116">getTags</a>()</pre>
<div class="block">Bean property getter: <property>tags</property>.
<p>
A list of tags for API documentation control.
@@ -603,7 +604,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.128">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>
+<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.129">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.
@@ -622,7 +623,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.142">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>
+<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.143">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.
@@ -641,7 +642,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.156">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>
+<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.157">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.
@@ -661,7 +662,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>tags</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.171">tags</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>
+<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.172">tags</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">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html#addTags-java.lang.String...-"><code>addTags(String...)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -677,7 +678,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>tags</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.181">tags</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>
+<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.182">tags</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">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html#addTags-java.util.Collection-"><code>addTags(Collection)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -693,7 +694,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.193">getSummary</a>()</pre>
+<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.194">getSummary</a>()</pre>
<div class="block">Bean property getter: <property>summary</property>.
<p>
A short summary of what the operation does.
@@ -710,7 +711,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.206">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>
+<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.207">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.
@@ -729,7 +730,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>summary</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.217">summary</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>
+<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">summary</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">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html#setSummary-java.lang.String-"><code>setSummary(String)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -745,14 +746,16 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.229">getDescription</a>()</pre>
+<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.232">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 for rich text representation.</div>
+ <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
+ for rich text representation.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
-<dd>The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.</dd>
+<dd>The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not
+ set.</dd>
</dl>
</li>
</ul>
@@ -762,11 +765,12 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.242">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>
+<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.246">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 for rich text representation.</div>
+ <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
+ for rich text representation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>description</code> - The new value for the <property>description</property> property on this bean.</dd>
@@ -781,7 +785,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>description</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.253">description</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>
+<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.257">description</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">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html#setDescription-java.lang.String-"><code>setDescription(String)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -797,13 +801,14 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.264">getExternalDocs</a>()</pre>
+<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.269">getExternalDocs</a>()</pre>
<div class="block">Bean property getter: <property>externalDocs</property>.
<p>
Additional external documentation for this operation.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
-<dd>The value of the <property>externalDocs</property> property on this bean, or <jk>null</jk> if it is not set.</dd>
+<dd>The value of the <property>externalDocs</property> property on this bean, or <jk>null</jk> if it is not
+ set.</dd>
</dl>
</li>
</ul>
@@ -813,7 +818,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.276">setExternalDocs</a>(<a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html" title="class in org.apache.juneau.dto.swagger">ExternalDocumentation</a> externalDocs)</pre>
+<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.281">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>
@@ -831,7 +836,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>externalDocs</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.287">externalDocs</a>(<a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html" title="class in org.apache.juneau.dto.swagger">ExternalDocumentation</a> externalDocs)</pre>
+<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.292">externalDocs</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">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html#setExternalDocs-org.apache.juneau.dto.swagger.ExternalDocumentation-"><code>setExternalDocs(ExternalDocumentation)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -847,14 +852,16 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.299">getOperationId</a>()</pre>
+<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.306">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 follow common programming naming conventions.</div>
+ Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to
+ follow common programming naming conventions.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
-<dd>The value of the <property>operationId</property> property on this bean, or <jk>null</jk> if it is not set.</dd>
+<dd>The value of the <property>operationId</property> property on this bean, or <jk>null</jk> if it is not
+ set.</dd>
</dl>
</li>
</ul>
@@ -864,11 +871,12 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.312">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>
+<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.320">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 follow common programming naming conventions.</div>
+ Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to
+ follow common programming naming conventions.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>operationId</code> - The new value for the <property>operationId</property> property on this bean.</dd>
@@ -883,7 +891,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>operationId</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.323">operationId</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>
+<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.331">operationId</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">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html#setOperationId-java.lang.String-"><code>setOperationId(String)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -899,13 +907,14 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.337">getConsumes</a>()</pre>
+<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.346">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.
An empty value MAY be used to clear the global definition.
- Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.</div>
+ Value MUST be as described under <a class="doclink"
+ href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The value of the <property>consumes</property> property on this bean, or <jk>null</jk> if it is not set.</dd>
@@ -918,13 +927,14 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.352">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>
+<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.362">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.
An empty value MAY be used to clear the global definition.
- Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.</div>
+ Value MUST be as described under <a class="doclink"
+ href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>consumes</code> - The new value for the <property>consumes</property> property on this bean.</dd>
@@ -939,13 +949,14 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.368">addConsumes</a>(<a href="../../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a>... consumes)</pre>
+<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">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.
An empty value MAY be used to clear the global definition.
- Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.</div>
+ Value MUST be as described under <a class="doclink"
+ href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>consumes</code> - The new values to add to the <property>consumes</property> property on this bean.</dd>
@@ -960,13 +971,14 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.383">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>
+<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.395">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.
An empty value MAY be used to clear the global definition.
- Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.</div>
+ Value MUST be as described under <a class="doclink"
+ href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>consumes</code> - The new values to add to the <property>consumes</property> property on this bean.</dd>
@@ -981,7 +993,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>consumes</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.398">consumes</a>(<a href="../../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a>... consumes)</pre>
+<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.410">consumes</a>(<a href="../../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a>... consumes)</pre>
<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html#addConsumes-org.apache.juneau.http.MediaType...-"><code>addConsumes(MediaType...)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -997,7 +1009,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>consumes</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.408">consumes</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>
+<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.420">consumes</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">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html#addConsumes-java.util.Collection-"><code>addConsumes(Collection)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -1013,13 +1025,14 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.422">getProduces</a>()</pre>
+<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.435">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.
An empty value MAY be used to clear the global definition.
- Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.</div>
+ Value MUST be as described under <a class="doclink"
+ href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The value of the <property>produces</property> property on this bean, or <jk>null</jk> if it is not set.</dd>
@@ -1032,13 +1045,14 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.437">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>
+<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.451">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.
An empty value MAY be used to clear the global definition.
- Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.</div>
+ Value MUST be as described under <a class="doclink"
+ href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>produces</code> - The new value for the <property>produces</property> property on this bean.</dd>
@@ -1053,13 +1067,14 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.453">addProduces</a>(<a href="../../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a>... produces)</pre>
+<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">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.
An empty value MAY be used to clear the global definition.
- Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.</div>
+ Value MUST be as described under <a class="doclink"
+ href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>produces</code> - The new value for the <property>produces</property> property on this bean.</dd>
@@ -1074,13 +1089,14 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.473">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>
+<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.489">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.
An empty value MAY be used to clear the global definition.
- Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.</div>
+ Value MUST be as described under <a class="doclink"
+ href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>produces</code> - The new values to add to the <property>produces</property> property on this bean.</dd>
@@ -1095,7 +1111,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>produces</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.488">produces</a>(<a href="../../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a>... produces)</pre>
+<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.504">produces</a>(<a href="../../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a>... produces)</pre>
<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html#addProduces-org.apache.juneau.http.MediaType...-"><code>addProduces(MediaType...)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -1111,7 +1127,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>produces</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.498">produces</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>
+<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.514">produces</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">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html#addProduces-java.util.Collection-"><code>addProduces(Collection)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -1127,14 +1143,19 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.514">getParameters</a>()</pre>
+<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.535">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" href="http://swagger.io/specification/#pathItemParameters">Path Item</a>, the new definition will override it, but can never remove it.
+ If a parameter is already defined at the <a class="doclink"
+ href="http://swagger.io/specification/#pathItemParameters">Path Item</a>, the new definition will override it,
+ but can never remove it.
The list MUST NOT include duplicated parameters.
A unique parameter is defined by a combination of a <code>name</code> and <code>location</code>.
- The list can use the <a class="doclink" href="http://swagger.io/specification/#referenceObject">Reference Object</a> to link to parameters that are defined at the <a class="doclink" href="http://swagger.io/specification/#swaggerParameters">Swagger Object's parameters</a>.
+ The list can use the <a class="doclink"
+ href="http://swagger.io/specification/#referenceObject">Reference Object</a> to link to parameters that are
+ defined at the <a class="doclink" href="http://swagger.io/specification/#swaggerParameters">Swagger Object's
+ parameters</a>.
There can be one <js>"body"</js> parameter at most.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -1148,14 +1169,19 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.531">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>
+<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.557">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" href="http://swagger.io/specification/#pathItemParameters">Path Item</a>, the new definition will override it, but can never remove it.
+ If a parameter is already defined at the <a class="doclink"
+ href="http://swagger.io/specification/#pathItemParameters">Path Item</a>, the new definition will override it,
+ but can never remove it.
The list MUST NOT include duplicated parameters.
A unique parameter is defined by a combination of a <code>name</code> and <code>location</code>.
- The list can use the <a class="doclink" href="http://swagger.io/specification/#referenceObject">Reference Object</a> to link to parameters that are defined at the <a class="doclink" href="http://swagger.io/specification/#swaggerParameters">Swagger Object's parameters</a>.
+ The list can use the <a class="doclink"
+ href="http://swagger.io/specification/#referenceObject">Reference Object</a> to link to parameters that are
+ defined at the <a class="doclink"
+ href="http://swagger.io/specification/#swaggerParameters">Swagger Object's parameters</a>.
There can be one <js>"body"</js> parameter at most.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -1171,14 +1197,19 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.549">addParameters</a>(<a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a>... parameters)</pre>
+<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.580">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" href="http://swagger.io/specification/#pathItemParameters">Path Item</a>, the new definition will override it, but can never remove it.
+ If a parameter is already defined at the <a class="doclink"
+ href="http://swagger.io/specification/#pathItemParameters">Path Item</a>, the new definition will override it,
+ but can never remove it.
The list MUST NOT include duplicated parameters.
A unique parameter is defined by a combination of a <code>name</code> and <code>location</code>.
- The list can use the <a class="doclink" href="http://swagger.io/specification/#referenceObject">Reference Object</a> to link to parameters that are defined at the <a class="doclink" href="http://swagger.io/specification/#swaggerParameters">Swagger Object's parameters</a>.
+ The list can use the <a class="doclink"
+ href="http://swagger.io/specification/#referenceObject">Reference Object</a> to link to parameters that are
+ defined at the <a class="doclink"
+ href="http://swagger.io/specification/#swaggerParameters">Swagger Object's parameters</a>.
There can be one <js>"body"</js> parameter at most.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -1194,7 +1225,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>parameters</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.562">parameters</a>(<a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a>... parameters)</pre>
+<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.593">parameters</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">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html#addParameters-org.apache.juneau.dto.swagger.ParameterInfo...-"><code>addParameters(ParameterInfo...)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -1210,7 +1241,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>parameters</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.572">parameters</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>
+<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.603">parameters</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">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html#setParameters-java.util.List-"><code>setParameters(List)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -1226,7 +1257,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.583">getResponses</a>()</pre>
+<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.614">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>
@@ -1242,7 +1273,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.595">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>
+<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.626">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>
@@ -1260,7 +1291,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>addResponse</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.609">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,
+<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.640">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>
@@ -1280,7 +1311,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>response</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.623">response</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,
+<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.654">response</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">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html#addResponse-java.lang.Integer-org.apache.juneau.dto.swagger.ResponseInfo-"><code>addResponse(Integer,ResponseInfo)</code></a>.</div>
<dl>
@@ -1298,7 +1329,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>responses</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.633">responses</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>
+<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.664">responses</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">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html#setResponses-java.util.Map-"><code>setResponses(Map)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -1314,7 +1345,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.646">getSchemes</a>()</pre>
+<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.677">getSchemes</a>()</pre>
<div class="block">Bean property getter: <property>schemes</property>.
<p>
The transfer protocol for the operation.
@@ -1332,7 +1363,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.660">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>
+<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.691">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.
@@ -1352,7 +1383,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.675">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>
+<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.706">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.
@@ -1372,7 +1403,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.689">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>
+<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.720">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.
@@ -1392,7 +1423,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>schemes</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.702">schemes</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>
+<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.733">schemes</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">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html#addSchemes-java.lang.String...-"><code>addSchemes(String...)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -1408,7 +1439,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.715">getDeprecated</a>()</pre>
+<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.746">getDeprecated</a>()</pre>
<div class="block">Bean property getter: <property>deprecated</property>.
<p>
Declares this operation to be deprecated.
@@ -1426,7 +1457,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.729">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>
+<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.760">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.
@@ -1446,7 +1477,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>deprecated</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.740">deprecated</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>
+<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.771">deprecated</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">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html#setDeprecated-java.lang.Boolean-"><code>setDeprecated(Boolean)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -1462,11 +1493,12 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.754">getSecurity</a>()</pre>
+<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.786">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 between the security requirements).
+ The list of values describes alternative security schemes that can be used (that is, there is a logical OR
+ between the security requirements).
This definition overrides any declared top-level security.
To remove a top-level <code>security</code> declaration, an empty array can be used.</div>
<dl>
@@ -1481,11 +1513,12 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.769">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>
+<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.802">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 between the security requirements).
+ The list of values describes alternative security schemes that can be used (that is, there is a logical OR
+ between the security requirements).
This definition overrides any declared top-level security.
To remove a top-level <code>security</code> declaration, an empty array can be used.</div>
<dl>
@@ -1502,11 +1535,12 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<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.785">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>
+<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.819">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 between the security requirements).
+ The list of values describes alternative security schemes that can be used (that is, there is a logical OR
+ between the security requirements).
This definition overrides any declared top-level security.
To remove a top-level <code>security</code> declaration, an empty array can be used.</div>
<dl>
@@ -1523,13 +1557,14 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockListLast">
<li class="blockList">
<h4>security</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.799">security</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> scheme,
+<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.834">security</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> scheme,
<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>... alternatives)</pre>
<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Operation.html#addSecurity-java.util.Map-"><code>addSecurity(Map)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>scheme</code> - The security scheme that applies to this operation</dd>
-<dd><code>alternatives</code> - The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements).</dd>
+<dd><code>alternatives</code> - The list of values describes alternative security schemes that can be used (that is, there is
+ a logical OR between the security requirements).</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object (for method chaining).</dd>
</dl>