http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2fd81719/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 new file mode 100644 index 0000000..2fcc18f --- /dev/null +++ b/content/site/apidocs/org/apache/juneau/dto/swagger/Swagger.html @@ -0,0 +1,1415 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Swagger (Apache Juneau (incubating) 6.0.0-incubating-SNAPSHOT)</title> +<link rel="stylesheet" type="text/css" href="../../../../../javadoc.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Swagger (Apache Juneau (incubating) 6.0.0-incubating-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":9,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/Swagger.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/juneau/dto/swagger/SecurityScheme.html" title="class in org.apache.juneau.dto.swagger"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/juneau/dto/swagger/Tag.html" title="class in org.apache.juneau.dto.swagger"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/juneau/dto/swagger/Swagger.html" target="_top">Frames</a></li> +<li><a href="Swagger.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.juneau.dto.swagger</div> +<h2 title="Class Swagger" class="title">Class Swagger</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.juneau.dto.swagger.Swagger</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<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.25">Swagger</a> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> +<div class="block">This is the root document object for the API specification.</div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>james.bognar</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#NULL">NULL</a></span></code> +<div class="block">Represents a null swagger</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#Swagger--">Swagger</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#addConsumes-java.util.Collection-">addConsumes</a></span>(<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>> consumes)</code> +<div class="block">Bean property adder: <property>consumes</property>.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#addConsumes-java.lang.String...-">addConsumes</a></span>(<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>... consumes)</code> +<div class="block">Bean property adder: <property>consumes</property>.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#addDefinition-java.lang.String-org.apache.juneau.dto.swagger.SchemaInfo-">addDefinition</a></span>(<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)</code> +<div class="block">Bean property adder: <property>definitions</property>.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#addParameter-java.lang.String-org.apache.juneau.dto.swagger.ParameterInfo-">addParameter</a></span>(<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)</code> +<div class="block">Bean property adder: <property>parameters</property>.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#addPath-java.lang.String-java.lang.String-org.apache.juneau.dto.swagger.Operation-">addPath</a></span>(<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)</code> +<div class="block">Bean property adder: <property>paths</property>.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#addProduces-java.util.Collection-">addProduces</a></span>(<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>> produces)</code> +<div class="block">Bean property adder: <property>produces</property>.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#addProduces-java.lang.String...-">addProduces</a></span>(<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>... produces)</code> +<div class="block">Bean property adder: <property>produces</property>.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#addResponse-java.lang.String-org.apache.juneau.dto.swagger.ResponseInfo-">addResponse</a></span>(<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)</code> +<div class="block">Bean property adder: <property>responses</property>.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#addSchemes-java.util.Collection-">addSchemes</a></span>(<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)</code> +<div class="block">Bean property adder: <property>schemes</property>.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#addSchemes-java.lang.String...-">addSchemes</a></span>(<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)</code> +<div class="block">Bean property adder: <property>schemes</property>.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#addSecurity-java.util.Map-">addSecurity</a></span>(<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)</code> +<div class="block">Bean property adder: <property>security</property>.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#addSecurityDefinition-java.lang.String-org.apache.juneau.dto.swagger.SecurityScheme-">addSecurityDefinition</a></span>(<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)</code> +<div class="block">Bean property adder: <property>securityDefinitions</property>.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#addTags-org.apache.juneau.dto.swagger.Tag...-">addTags</a></span>(<a href="../../../../../org/apache/juneau/dto/swagger/Tag.html" title="class in org.apache.juneau.dto.swagger">Tag</a>... tags)</code> +<div class="block">Bean property adder: <property>tags</property>.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#create-org.apache.juneau.dto.swagger.Info-">create</a></span>(<a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a> info)</code> +<div class="block">Convenience method for creating a new Swagger object.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code><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></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#getBasePath--">getBasePath</a></span>()</code> +<div class="block">Bean property getter: <property>basePath</property>.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code><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>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#getConsumes--">getConsumes</a></span>()</code> +<div class="block">Bean property getter: <property>consumes</property>.</div> +</td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code><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>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#getDefinitions--">getDefinitions</a></span>()</code> +<div class="block">Bean property getter: <property>definitions</property>.</div> +</td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html" title="class in org.apache.juneau.dto.swagger">ExternalDocumentation</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#getExternalDocs--">getExternalDocs</a></span>()</code> +<div class="block">Bean property getter: <property>externalDocs</property>.</div> +</td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code><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></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#getHost--">getHost</a></span>()</code> +<div class="block">Bean property getter: <property>host</property>.</div> +</td> +</tr> +<tr id="i19" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#getInfo--">getInfo</a></span>()</code> +<div class="block">Bean property getter: <property>info</property>.</div> +</td> +</tr> +<tr id="i20" class="altColor"> +<td class="colFirst"><code><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>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#getParameters--">getParameters</a></span>()</code> +<div class="block">Bean property getter: <property>parameters</property>.</div> +</td> +</tr> +<tr id="i21" class="rowColor"> +<td class="colFirst"><code><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>>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#getPaths--">getPaths</a></span>()</code> +<div class="block">Bean property getter: <property>paths</property>.</div> +</td> +</tr> +<tr id="i22" class="altColor"> +<td class="colFirst"><code><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>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#getProduces--">getProduces</a></span>()</code> +<div class="block">Bean property getter: <property>produces</property>.</div> +</td> +</tr> +<tr id="i23" class="rowColor"> +<td class="colFirst"><code><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>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#getResponses--">getResponses</a></span>()</code> +<div class="block">Bean property getter: <property>responses</property>.</div> +</td> +</tr> +<tr id="i24" class="altColor"> +<td class="colFirst"><code><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>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#getSchemes--">getSchemes</a></span>()</code> +<div class="block">Bean property getter: <property>schemes</property>.</div> +</td> +</tr> +<tr id="i25" class="rowColor"> +<td class="colFirst"><code><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>>>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#getSecurity--">getSecurity</a></span>()</code> +<div class="block">Bean property getter: <property>security</property>.</div> +</td> +</tr> +<tr id="i26" class="altColor"> +<td class="colFirst"><code><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>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#getSecurityDefinitions--">getSecurityDefinitions</a></span>()</code> +<div class="block">Bean property getter: <property>securityDefinitions</property>.</div> +</td> +</tr> +<tr id="i27" class="rowColor"> +<td class="colFirst"><code><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></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#getSwagger--">getSwagger</a></span>()</code> +<div class="block">Bean property getter: <property>swagger</property>.</div> +</td> +</tr> +<tr id="i28" class="altColor"> +<td class="colFirst"><code><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>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#getTags--">getTags</a></span>()</code> +<div class="block">Bean property getter: <property>tags</property>.</div> +</td> +</tr> +<tr id="i29" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#setBasePath-java.lang.String-">setBasePath</a></span>(<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)</code> +<div class="block">Bean property setter: <property>basePath</property>.</div> +</td> +</tr> +<tr id="i30" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#setConsumes-java.util.List-">setConsumes</a></span>(<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>> consumes)</code> +<div class="block">Bean property setter: <property>consumes</property>.</div> +</td> +</tr> +<tr id="i31" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#setDefinitions-java.util.Map-">setDefinitions</a></span>(<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)</code> +<div class="block">Bean property setter: <property>definitions</property>.</div> +</td> +</tr> +<tr id="i32" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#setExternalDocs-org.apache.juneau.dto.swagger.ExternalDocumentation-">setExternalDocs</a></span>(<a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html" title="class in org.apache.juneau.dto.swagger">ExternalDocumentation</a> externalDocs)</code> +<div class="block">Bean property setter: <property>externalDocs</property>.</div> +</td> +</tr> +<tr id="i33" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#setHost-java.lang.String-">setHost</a></span>(<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)</code> +<div class="block">Bean property setter: <property>host</property>.</div> +</td> +</tr> +<tr id="i34" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#setInfo-org.apache.juneau.dto.swagger.Info-">setInfo</a></span>(<a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a> info)</code> +<div class="block">Bean property setter: <property>info</property>.</div> +</td> +</tr> +<tr id="i35" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#setParameters-java.util.Map-">setParameters</a></span>(<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)</code> +<div class="block">Bean property setter: <property>parameters</property>.</div> +</td> +</tr> +<tr id="i36" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#setPaths-java.util.Map-">setPaths</a></span>(<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)</code> +<div class="block">Bean property setter: <property>paths</property>.</div> +</td> +</tr> +<tr id="i37" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#setProduces-java.util.List-">setProduces</a></span>(<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>> produces)</code> +<div class="block">Bean property setter: <property>produces</property>.</div> +</td> +</tr> +<tr id="i38" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#setResponses-java.util.Map-">setResponses</a></span>(<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)</code> +<div class="block">Bean property setter: <property>responses</property>.</div> +</td> +</tr> +<tr id="i39" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#setSchemes-java.util.List-">setSchemes</a></span>(<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)</code> +<div class="block">Bean property setter: <property>schemes</property>.</div> +</td> +</tr> +<tr id="i40" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#setSecurity-java.util.List-">setSecurity</a></span>(<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)</code> +<div class="block">Bean property setter: <property>security</property>.</div> +</td> +</tr> +<tr id="i41" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#setSecurityDefinitions-java.util.Map-">setSecurityDefinitions</a></span>(<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)</code> +<div class="block">Bean property setter: <property>securityDefinitions</property>.</div> +</td> +</tr> +<tr id="i42" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#setSwagger-java.lang.String-">setSwagger</a></span>(<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)</code> +<div class="block">Bean property setter: <property>swagger</property>.</div> +</td> +</tr> +<tr id="i43" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html#setTags-java.util.List-">setTags</a></span>(<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)</code> +<div class="block">Bean property setter: <property>tags</property>.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="NULL"> +<!-- --> +</a> +<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.28">NULL</a></pre> +<div class="block">Represents a null swagger</div> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="Swagger--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Swagger</h4> +<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Swagger.html#line.25">Swagger</a>()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="create-org.apache.juneau.dto.swagger.Info-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>create</h4> +<pre>public static <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.52">create</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">Convenience method for creating a new Swagger object.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>info</code> - Required. Provides metadata about the API. + The metadata can be used by the clients if needed.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A new Swagger object.</dd> +</dl> +</li> +</ul> +<a name="getSwagger--"> +<!-- --> +</a> +<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.65">getSwagger</a>()</pre> +<div class="block">Bean property getter: <property>swagger</property>. + <p> + Required. Specifies the Swagger Specification version being used. + It can be used by the Swagger UI and other clients to interpret the API listing. + The value MUST be <js>"2.0"</js>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The value of the <property>swagger</property> property on this bean, or <jk>null</jk> if it is not set.</dd> +</dl> +</li> +</ul> +<a name="setSwagger-java.lang.String-"> +<!-- --> +</a> +<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.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. + It can be used by the Swagger UI and other clients to interpret the API listing. + The value MUST be <js>"2.0"</js>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>swagger</code> - The new value for the <property>swagger</property> property on this bean.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="getInfo--"> +<!-- --> +</a> +<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.92">getInfo</a>()</pre> +<div class="block">Bean property getter: <property>info</property>. + <p> + Required. Provides metadata about the API. + The metadata can be used by the clients if needed.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The value of the <property>info</property> property on this bean, or <jk>null</jk> if it is not set.</dd> +</dl> +</li> +</ul> +<a name="setInfo-org.apache.juneau.dto.swagger.Info-"> +<!-- --> +</a> +<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.105">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. + The metadata can be used by the clients if needed.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>info</code> - The new value for the <property>info</property> property on this bean.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="getHost--"> +<!-- --> +</a> +<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.121">getHost</a>()</pre> +<div class="block">Bean property getter: <property>host</property>. + <p> + 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 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> +</dl> +</li> +</ul> +<a name="setHost-java.lang.String-"> +<!-- --> +</a> +<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.137">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. + 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 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> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="getBasePath--"> +<!-- --> +</a> +<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.152">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 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> +</dl> +</li> +</ul> +<a name="setBasePath-java.lang.String-"> +<!-- --> +</a> +<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.167">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 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> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="getSchemes--"> +<!-- --> +</a> +<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.181">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> +<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> +</dl> +</li> +</ul> +<a name="setSchemes-java.util.List-"> +<!-- --> +</a> +<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.195">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> +<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> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="addSchemes-java.lang.String...-"> +<!-- --> +</a> +<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.211">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> +<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> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="addSchemes-java.util.Collection-"> +<!-- --> +</a> +<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.226">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> +<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> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="getConsumes--"> +<!-- --> +</a> +<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="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.242">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 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> +</dl> +</li> +</ul> +<a name="setConsumes-java.util.List-"> +<!-- --> +</a> +<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.256">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="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</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 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> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="addConsumes-java.lang.String...-"> +<!-- --> +</a> +<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.272">addConsumes</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>... 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 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> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="addConsumes-java.util.Collection-"> +<!-- --> +</a> +<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.287">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="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</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 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> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="getProduces--"> +<!-- --> +</a> +<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="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.303">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 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> +</dl> +</li> +</ul> +<a name="setProduces-java.util.List-"> +<!-- --> +</a> +<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.317">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="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</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 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> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="addProduces-java.lang.String...-"> +<!-- --> +</a> +<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.333">addProduces</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>... 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 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> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="addProduces-java.util.Collection-"> +<!-- --> +</a> +<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.348">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="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</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 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> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="getPaths--"> +<!-- --> +</a> +<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.362">getPaths</a>()</pre> +<div class="block">Bean property getter: <property>paths</property>. + <p> + Required. The available paths and operations for the API.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The value of the <property>paths</property> property on this bean, or <jk>null</jk> if it is not set.</dd> +</dl> +</li> +</ul> +<a name="setPaths-java.util.Map-"> +<!-- --> +</a> +<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.374">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> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>paths</code> - The new value for the <property>paths</property> property on this bean.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="addPath-java.lang.String-java.lang.String-org.apache.juneau.dto.swagger.Operation-"> +<!-- --> +</a> +<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.389">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>. + <p> + Required. The available paths and operations for the API.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>path</code> - The path template.</dd> +<dd><code>methodName</code> - The HTTP method name.</dd> +<dd><code>operation</code> - The operation that describes the path.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="getDefinitions--"> +<!-- --> +</a> +<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.408">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> +</dl> +</li> +</ul> +<a name="setDefinitions-java.util.Map-"> +<!-- --> +</a> +<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.420">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> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>definitions</code> - The new value for the <property>definitions</property> property on this bean.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="addDefinition-java.lang.String-org.apache.juneau.dto.swagger.SchemaInfo-"> +<!-- --> +</a> +<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.434">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> + An object to hold data types produced and consumed by operations.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - A definition name.</dd> +<dd><code>schema</code> - The schema that the name defines.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="getParameters--"> +<!-- --> +</a> +<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.449">getParameters</a>()</pre> +<div class="block">Bean property getter: <property>parameters</property>. + <p> + An object to hold parameters that can be used across operations. + This property does not define global parameters for all operations.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The value of the <property>parameters</property> property on this bean, or <jk>null</jk> if it is not set.</dd> +</dl> +</li> +</ul> +<a name="setParameters-java.util.Map-"> +<!-- --> +</a> +<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.462">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. + This property does not define global parameters for all operations.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>parameters</code> - The new value for the <property>parameters</property> property on this bean.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="addParameter-java.lang.String-org.apache.juneau.dto.swagger.ParameterInfo-"> +<!-- --> +</a> +<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.477">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> + An object to hold parameters that can be used across operations. + This property does not define global parameters for all operations.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - The parameter name.</dd> +<dd><code>parameter</code> - The parameter definition.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="getResponses--"> +<!-- --> +</a> +<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.492">getResponses</a>()</pre> +<div class="block">Bean property getter: <property>responses</property>. + <p> + An object to hold responses that can be used across operations. + This property does not define global responses for all operations.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The value of the <property>responses</property> property on this bean, or <jk>null</jk> if it is not set.</dd> +</dl> +</li> +</ul> +<a name="setResponses-java.util.Map-"> +<!-- --> +</a> +<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.505">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. + This property does not define global responses for all operations.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>responses</code> - The new value for the <property>responses</property> property on this bean.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="addResponse-java.lang.String-org.apache.juneau.dto.swagger.ResponseInfo-"> +<!-- --> +</a> +<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.520">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> + An object to hold responses that can be used across operations. + This property does not define global responses for all operations.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - The response name.</dd> +<dd><code>response</code> - The response definition.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="getSecurityDefinitions--"> +<!-- --> +</a> +<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.534">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> +</dl> +</li> +</ul> +<a name="setSecurityDefinitions-java.util.Map-"> +<!-- --> +</a> +<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.546">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> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>securityDefinitions</code> - The new value for the <property>securityDefinitions</property> property on this bean.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="addSecurityDefinition-java.lang.String-org.apache.juneau.dto.swagger.SecurityScheme-"> +<!-- --> +</a> +<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.560">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> + Security scheme definitions that can be used across the specification.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - A security name.</dd> +<dd><code>securityScheme</code> - A security schema.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="getSecurity--"> +<!-- --> +</a> +<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.576">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). + Individual operations can override this definition.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The value of the <property>security</property> property on this bean, or <jk>null</jk> if it is not set.</dd> +</dl> +</li> +</ul> +<a name="setSecurity-java.util.List-"> +<!-- --> +</a> +<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.590">setSecurity</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-exter
<TRUNCATED>
