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:46 UTC
[02/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/Swagger.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/dto/swagger/Swagger.html b/content/site/apidocs/org/apache/juneau/dto/swagger/Swagger.html
index cfdf230..0401df2 100644
--- a/content/site/apidocs/org/apache/juneau/dto/swagger/Swagger.html
+++ b/content/site/apidocs/org/apache/juneau/dto/swagger/Swagger.html
@@ -114,13 +114,14 @@ 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>="swagger,info,tags,externalDocs,basePath,schemes,consumes,produces,paths,definitions,parameters,responses,securityDefinitions,security")
-public class <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.35">Swagger</a>
+public class <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.36">Swagger</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">This is the root document object for the API specification.
<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>
@@ -596,7 +597,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockListLast">
<li class="blockList">
<h4>NULL</h4>
-<pre>public static final <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.38">NULL</a></pre>
+<pre>public static final <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.39">NULL</a></pre>
<div class="block">Represents a null swagger</div>
</li>
</ul>
@@ -614,7 +615,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockListLast">
<li class="blockList">
<h4>Swagger</h4>
-<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.35">Swagger</a>()</pre>
+<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.36">Swagger</a>()</pre>
</li>
</ul>
</li>
@@ -631,7 +632,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>getSwagger</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/Swagger.html#line.64">getSwagger</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/Swagger.html#line.65">getSwagger</a>()</pre>
<div class="block">Bean property getter: <property>swagger</property>.
<p>
Required. Specifies the Swagger Specification version being used.
@@ -649,7 +650,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>setSwagger</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.78">setSwagger</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> swagger)</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.79">setSwagger</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> swagger)</pre>
<div class="block">Bean property setter: <property>swagger</property>.
<p>
Required. Specifies the Swagger Specification version being used.
@@ -669,7 +670,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>swagger</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.89">swagger</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> swagger)</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.90">swagger</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> swagger)</pre>
<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#setSwagger-java.lang.String-"><code>setSwagger(String)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -685,7 +686,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>getInfo</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.101">getInfo</a>()</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.102">getInfo</a>()</pre>
<div class="block">Bean property getter: <property>info</property>.
<p>
Required. Provides metadata about the API.
@@ -702,7 +703,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>setInfo</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.114">setInfo</a>(<a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a> info)</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.115">setInfo</a>(<a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a> info)</pre>
<div class="block">Bean property setter: <property>info</property>.
<p>
Required. Provides metadata about the API.
@@ -721,7 +722,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>info</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.125">info</a>(<a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a> info)</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.126">info</a>(<a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a> info)</pre>
<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#setInfo-org.apache.juneau.dto.swagger.Info-"><code>setInfo(Info)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -737,14 +738,15 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>getHost</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/Swagger.html#line.140">getHost</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/Swagger.html#line.142">getHost</a>()</pre>
<div class="block">Bean property getter: <property>host</property>.
<p>
- The host (name or ip) serving the API.
+ The host (name or IP) serving the API.
This MUST be the host only and does not include the scheme nor sub-paths.
It MAY include a port.
If the host is not included, the host serving the documentation is to be used (including the port).
- The host does not support <a class="doclink" href="http://swagger.io/specification/#pathTemplating">path templating</a>.</div>
+ The host does not support <a class="doclink" href="http://swagger.io/specification/#pathTemplating">
+ path templating</a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The value of the <property>host</property> property on this bean, or <jk>null</jk> if it is not set.</dd>
@@ -757,14 +759,15 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>setHost</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.156">setHost</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> host)</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.159">setHost</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> host)</pre>
<div class="block">Bean property setter: <property>host</property>.
<p>
- The host (name or ip) serving the API.
+ The host (name or IP) serving the API.
This MUST be the host only and does not include the scheme nor sub-paths.
It MAY include a port.
If the host is not included, the host serving the documentation is to be used (including the port).
- The host does not support <a class="doclink" href="http://swagger.io/specification/#pathTemplating">path templating</a>.</div>
+ The host does not support <a class="doclink" href="http://swagger.io/specification/#pathTemplating">
+ path templating</a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>host</code> - The new value for the <property>host</property> property on this bean.</dd>
@@ -779,7 +782,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>host</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.167">host</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> host)</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.170">host</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> host)</pre>
<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#setHost-java.lang.String-"><code>setHost(String)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -795,13 +798,14 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>getBasePath</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/Swagger.html#line.181">getBasePath</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/Swagger.html#line.185">getBasePath</a>()</pre>
<div class="block">Bean property getter: <property>basePath</property>.
<p>
The base path on which the API is served, which is relative to the <code>host</code>.
If it is not included, the API is served directly under the <code>host</code>.
The value MUST start with a leading slash (/).
- The <code>basePath</code> does not support <a class="doclink" href="http://swagger.io/specification/#pathTemplating">path templating</a>.</div>
+ The <code>basePath</code> does not support <a class="doclink"
+ href="http://swagger.io/specification/#pathTemplating">path templating</a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The value of the <property>basePath</property> property on this bean, or <jk>null</jk> if it is not set.</dd>
@@ -814,13 +818,14 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>setBasePath</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.196">setBasePath</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> basePath)</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.201">setBasePath</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> basePath)</pre>
<div class="block">Bean property setter: <property>basePath</property>.
<p>
The base path on which the API is served, which is relative to the <code>host</code>.
If it is not included, the API is served directly under the <code>host</code>.
The value MUST start with a leading slash (/).
- The <code>basePath</code> does not support <a class="doclink" href="http://swagger.io/specification/#pathTemplating">path templating</a>.</div>
+ The <code>basePath</code> does not support <a class="doclink"
+ href="http://swagger.io/specification/#pathTemplating">path templating</a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>basePath</code> - The new value for the <property>basePath</property> property on this bean.</dd>
@@ -835,7 +840,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>basePath</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.207">basePath</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> basePath)</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.212">basePath</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> basePath)</pre>
<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#setBasePath-java.lang.String-"><code>setBasePath(String)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -851,12 +856,13 @@ 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/Swagger.html#line.220">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/Swagger.html#line.226">getSchemes</a>()</pre>
<div class="block">Bean property getter: <property>schemes</property>.
<p>
The transfer protocol of the API.
Values MUST be from the list: <js>"http"</js>, <js>"https"</js>, <js>"ws"</js>, <js>"wss"</js>.
- If the <code>schemes</code> is not included, the default scheme to be used is the one used to access the Swagger definition itself.</div>
+ If the <code>schemes</code> is not included, the default scheme to be used is the one used to access the Swagger
+ definition itself.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The value of the <property>schemes</property> property on this bean, or <jk>null</jk> if it is not set.</dd>
@@ -869,12 +875,13 @@ 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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.234">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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.241">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 of the API.
Values MUST be from the list: <js>"http"</js>, <js>"https"</js>, <js>"ws"</js>, <js>"wss"</js>.
- If the <code>schemes</code> is not included, the default scheme to be used is the one used to access the Swagger definition itself.</div>
+ If the <code>schemes</code> is not included, the default scheme to be used is the one used to access the Swagger
+ definition itself.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>schemes</code> - The new value for the <property>schemes</property> property on this bean.</dd>
@@ -889,12 +896,13 @@ 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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.249">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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.257">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 of the API.
Values MUST be from the list: <js>"http"</js>, <js>"https"</js>, <js>"ws"</js>, <js>"wss"</js>.
- If the <code>schemes</code> is not included, the default scheme to be used is the one used to access the Swagger definition itself.</div>
+ If the <code>schemes</code> is not included, the default scheme to be used is the one used to access the Swagger
+ definition itself.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>schemes</code> - The values to add for the <property>schemes</property> property on this bean.</dd>
@@ -909,12 +917,13 @@ 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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.263">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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.272">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 of the API.
Values MUST be from the list: <js>"http"</js>, <js>"https"</js>, <js>"ws"</js>, <js>"wss"</js>.
- If the <code>schemes</code> is not included, the default scheme to be used is the one used to access the Swagger definition itself.</div>
+ If the <code>schemes</code> is not included, the default scheme to be used is the one used to access the Swagger
+ definition itself.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>schemes</code> - The values to add for the <property>schemes</property> property on this bean.</dd>
@@ -929,7 +938,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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.278">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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.287">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/Swagger.html#addSchemes-java.lang.String...-"><code>addSchemes(String...)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -945,12 +954,13 @@ 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/Swagger.html#line.291">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/Swagger.html#line.301">getConsumes</a>()</pre>
<div class="block">Bean property getter: <property>consumes</property>.
<p>
A list of MIME types the APIs can consume.
This is global to all APIs but can be overridden on specific API calls.
- 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>
@@ -963,12 +973,13 @@ 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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.305">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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.316">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 APIs can consume.
This is global to all APIs but can be overridden on specific API calls.
- 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>
@@ -983,12 +994,13 @@ 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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.320">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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.332">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 APIs can consume.
This is global to all APIs but can be overridden on specific API calls.
- 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 values to add for the <property>consumes</property> property on this bean.</dd>
@@ -1003,12 +1015,13 @@ 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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.334">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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.347">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 APIs can consume.
This is global to all APIs but can be overridden on specific API calls.
- 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 values to add for the <property>consumes</property> property on this bean.</dd>
@@ -1023,7 +1036,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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.349">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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.362">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/Swagger.html#addConsumes-org.apache.juneau.http.MediaType...-"><code>addConsumes(MediaType...)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -1039,7 +1052,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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.359">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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.372">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/Swagger.html#addConsumes-java.util.Collection-"><code>addConsumes(Collection)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -1055,12 +1068,13 @@ 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/Swagger.html#line.372">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/Swagger.html#line.386">getProduces</a>()</pre>
<div class="block">Bean property getter: <property>produces</property>.
<p>
A list of MIME types the APIs can produce.
This is global to all APIs but can be overridden on specific API calls.
- 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>
@@ -1073,12 +1087,13 @@ 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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.386">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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.401">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 APIs can produce.
This is global to all APIs but can be overridden on specific API calls.
- 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>
@@ -1093,12 +1108,13 @@ 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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.401">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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.417">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 APIs can produce.
This is global to all APIs but can be overridden on specific API calls.
- 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 values to add for the <property>produces</property> property on this bean.</dd>
@@ -1113,12 +1129,13 @@ 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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.415">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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.432">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 APIs can produce.
This is global to all APIs but can be overridden on specific API calls.
- 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 values to add for the <property>produces</property> property on this bean.</dd>
@@ -1133,7 +1150,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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.430">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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.447">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/Swagger.html#addProduces-org.apache.juneau.http.MediaType...-"><code>addProduces(MediaType...)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -1149,7 +1166,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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.440">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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.457">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/Swagger.html#addProduces-java.util.Collection-"><code>addProduces(Collection)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -1165,7 +1182,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>getPaths</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/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/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="../../../../../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/Swagger.html#line.451">getPaths</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/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/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="../../../../../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/Swagger.html#line.468">getPaths</a>()</pre>
<div class="block">Bean property getter: <property>paths</property>.
<p>
Required. The available paths and operations for the API.</div>
@@ -1181,7 +1198,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>setPaths</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.463">setPaths</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/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="../../../../../org/apache/juneau/dto/swagger/Operation.html" title="class in org.apache.juneau.dto.swagger">Operation</a>>> paths)</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.480">setPaths</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/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="../../../../../org/apache/juneau/dto/swagger/Operation.html" title="class in org.apache.juneau.dto.swagger">Operation</a>>> paths)</pre>
<div class="block">Bean property setter: <property>paths</property>.
<p>
Required. The available paths and operations for the API.</div>
@@ -1199,7 +1216,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>addPath</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.478">addPath</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> path,
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.495">addPath</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> path,
<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> methodName,
<a href="../../../../../org/apache/juneau/dto/swagger/Operation.html" title="class in org.apache.juneau.dto.swagger">Operation</a> operation)</pre>
<div class="block">Bean property adder: <property>paths</property>.
@@ -1221,7 +1238,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>path</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.498">path</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> path,
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.515">path</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> path,
<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> methodName,
<a href="../../../../../org/apache/juneau/dto/swagger/Operation.html" title="class in org.apache.juneau.dto.swagger">Operation</a> operation)</pre>
<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#path-java.lang.String-java.lang.String-org.apache.juneau.dto.swagger.Operation-"><code>path(String,String,Operation)</code></a>.</div>
@@ -1241,13 +1258,14 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>getDefinitions</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/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../org/apache/juneau/dto/swagger/SchemaInfo.html" title="class in org.apache.juneau.dto.swagger">SchemaInfo</a>> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.509">getDefinitions</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/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../org/apache/juneau/dto/swagger/SchemaInfo.html" title="class in org.apache.juneau.dto.swagger">SchemaInfo</a>> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.527">getDefinitions</a>()</pre>
<div class="block">Bean property getter: <property>definitions</property>.
<p>
An object to hold data types produced and consumed by operations.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
-<dd>The value of the <property>definitions</property> property on this bean, or <jk>null</jk> if it is not set.</dd>
+<dd>The value of the <property>definitions</property> property on this bean, or <jk>null</jk> if it is not
+ set.</dd>
</dl>
</li>
</ul>
@@ -1257,7 +1275,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>setDefinitions</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.521">setDefinitions</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="../../../../../org/apache/juneau/dto/swagger/SchemaInfo.html" title="class in org.apache.juneau.dto.swagger">SchemaInfo</a>> definitions)</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.539">setDefinitions</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="../../../../../org/apache/juneau/dto/swagger/SchemaInfo.html" title="class in org.apache.juneau.dto.swagger">SchemaInfo</a>> definitions)</pre>
<div class="block">Bean property setter: <property>definitions</property>.
<p>
An object to hold data types produced and consumed by operations.</div>
@@ -1275,7 +1293,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>addDefinition</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.535">addDefinition</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>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.553">addDefinition</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,
<a href="../../../../../org/apache/juneau/dto/swagger/SchemaInfo.html" title="class in org.apache.juneau.dto.swagger">SchemaInfo</a> schema)</pre>
<div class="block">Bean property adder: <property>definitions</property>.
<p>
@@ -1295,7 +1313,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>xxx</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.549">xxx</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>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.567">xxx</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,
<a href="../../../../../org/apache/juneau/dto/swagger/SchemaInfo.html" title="class in org.apache.juneau.dto.swagger">SchemaInfo</a> schema)</pre>
<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#addDefinition-java.lang.String-org.apache.juneau.dto.swagger.SchemaInfo-"><code>addDefinition(String,SchemaInfo)</code></a>.</div>
<dl>
@@ -1313,7 +1331,7 @@ 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/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="../../../../../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/Swagger.html#line.561">getParameters</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/String.html?is-external=true" title="class or interface in java.lang">String</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/Swagger.html#line.579">getParameters</a>()</pre>
<div class="block">Bean property getter: <property>parameters</property>.
<p>
An object to hold parameters that can be used across operations.
@@ -1330,7 +1348,7 @@ 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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.574">setParameters</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="../../../../../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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.592">setParameters</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="../../../../../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>
An object to hold parameters that can be used across operations.
@@ -1349,7 +1367,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>addParameter</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.589">addParameter</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>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.607">addParameter</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,
<a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a> parameter)</pre>
<div class="block">Bean property adder: <property>parameters</property>.
<p>
@@ -1370,7 +1388,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>parameter</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.603">parameter</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>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.621">parameter</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,
<a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a> parameter)</pre>
<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#addParameter-java.lang.String-org.apache.juneau.dto.swagger.ParameterInfo-"><code>addParameter(String,ParameterInfo)</code></a>.</div>
<dl>
@@ -1388,7 +1406,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/String.html?is-external=true" title="class or interface in java.lang">String</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/Swagger.html#line.615">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/String.html?is-external=true" title="class or interface in java.lang">String</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/Swagger.html#line.633">getResponses</a>()</pre>
<div class="block">Bean property getter: <property>responses</property>.
<p>
An object to hold responses that can be used across operations.
@@ -1405,7 +1423,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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.628">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/String.html?is-external=true" title="class or interface in java.lang">String</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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.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/String.html?is-external=true" title="class or interface in java.lang">String</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>
An object to hold responses that can be used across operations.
@@ -1424,7 +1442,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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.643">addResponse</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>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.661">addResponse</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,
<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>
@@ -1445,7 +1463,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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.657">response</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>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.675">response</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,
<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/Swagger.html#addResponse-java.lang.String-org.apache.juneau.dto.swagger.ResponseInfo-"><code>addResponse(String,ResponseInfo)</code></a>.</div>
<dl>
@@ -1463,13 +1481,14 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>getSecurityDefinitions</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/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../org/apache/juneau/dto/swagger/SecurityScheme.html" title="class in org.apache.juneau.dto.swagger">SecurityScheme</a>> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.668">getSecurityDefinitions</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/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../org/apache/juneau/dto/swagger/SecurityScheme.html" title="class in org.apache.juneau.dto.swagger">SecurityScheme</a>> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.687">getSecurityDefinitions</a>()</pre>
<div class="block">Bean property getter: <property>securityDefinitions</property>.
<p>
Security scheme definitions that can be used across the specification.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
-<dd>The value of the <property>securityDefinitions</property> property on this bean, or <jk>null</jk> if it is not set.</dd>
+<dd>The value of the <property>securityDefinitions</property> property on this bean, or <jk>null</jk> if it
+ is not set.</dd>
</dl>
</li>
</ul>
@@ -1479,7 +1498,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>setSecurityDefinitions</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.680">setSecurityDefinitions</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="../../../../../org/apache/juneau/dto/swagger/SecurityScheme.html" title="class in org.apache.juneau.dto.swagger">SecurityScheme</a>> securityDefinitions)</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.699">setSecurityDefinitions</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="../../../../../org/apache/juneau/dto/swagger/SecurityScheme.html" title="class in org.apache.juneau.dto.swagger">SecurityScheme</a>> securityDefinitions)</pre>
<div class="block">Bean property setter: <property>securityDefinitions</property>.
<p>
Security scheme definitions that can be used across the specification.</div>
@@ -1497,7 +1516,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>addSecurityDefinition</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.694">addSecurityDefinition</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>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.713">addSecurityDefinition</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,
<a href="../../../../../org/apache/juneau/dto/swagger/SecurityScheme.html" title="class in org.apache.juneau.dto.swagger">SecurityScheme</a> securityScheme)</pre>
<div class="block">Bean property adder: <property>securityDefinitions</property>.
<p>
@@ -1517,7 +1536,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>securityDefinition</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.708">securityDefinition</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>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.727">securityDefinition</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,
<a href="../../../../../org/apache/juneau/dto/swagger/SecurityScheme.html" title="class in org.apache.juneau.dto.swagger">SecurityScheme</a> securityScheme)</pre>
<div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#addSecurityDefinition-java.lang.String-org.apache.juneau.dto.swagger.SecurityScheme-"><code>addSecurityDefinition(String,SecurityScheme)</code></a>.</div>
<dl>
@@ -1535,11 +1554,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/Swagger.html#line.721">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/Swagger.html#line.741">getSecurity</a>()</pre>
<div class="block">Bean property getter: <property>security</property>.
<p>
A declaration of which security schemes are applied for the API as a whole.
- 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).
Individual operations can override this definition.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -1553,11 +1573,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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.735">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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.756">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 the API as a whole.
- 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).
Individual operations can override this definition.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -1573,11 +1594,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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.750">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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.772">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 the API as a whole.
- 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).
Individual operations can override this definition.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -1593,13 +1615,14 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm
<ul class="blockList">
<li class="blockList">
<h4>security</h4>
-<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.764">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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.787">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/Swagger.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>
@@ -1611,12 +1634,13 @@ 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="../../../../../org/apache/juneau/dto/swagger/Tag.html" title="class in org.apache.juneau.dto.swagger">Tag</a>> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.781">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="../../../../../org/apache/juneau/dto/swagger/Tag.html" title="class in org.apache.juneau.dto.swagger">Tag</a>> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.805">getTags</a>()</pre>
<div class="block">Bean property getter: <property>tags</property>.
<p>
A list of tags used by the specification with additional metadata.
The order of the tags can be used to reflect on their order by the parsing tools.
- Not all tags that are used by the <a class="doclink" href="http://swagger.io/specification/#operationObject">Operation Object</a> must be declared.
+ Not all tags that are used by the <a class="doclink" href="http://swagger.io/specification/#operationObject">
+ Operation Object</a> must be declared.
The tags that are not declared may be organized randomly or based on the tools' logic.
Each tag name in the list MUST be unique.</div>
<dl>
@@ -1631,12 +1655,13 @@ 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/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.797">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="../../../../../org/apache/juneau/dto/swagger/Tag.html" title="class in org.apache.juneau.dto.swagger">Tag</a>> tags)</pre>
+<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.822">setTags</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class o
<TRUNCATED>