http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/017373e3/content/site/apidocs/org/apache/juneau/rest/annotation/ResourceSwagger.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/ResourceSwagger.html b/content/site/apidocs/org/apache/juneau/rest/annotation/ResourceSwagger.html new file mode 100644 index 0000000..8c6aa33 --- /dev/null +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/ResourceSwagger.html @@ -0,0 +1,474 @@ +<!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>ResourceSwagger (Apache Juneau (incubating) 6.2.1-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="ResourceSwagger (Apache Juneau (incubating) 6.2.1-incubating-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/juneau/rest/annotation/Query.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/juneau/rest/annotation/Response.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/juneau/rest/annotation/ResourceSwagger.html" target="_top">Frames</a></li> +<li><a href="ResourceSwagger.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>Field | </li> +<li>Required | </li> +<li><a href="#annotation.type.optional.element.summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#annotation.type.element.detail">Element</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.juneau.rest.annotation</div> +<h2 title="Annotation Type ResourceSwagger" class="title">Annotation Type ResourceSwagger</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annotation/ResourceSwagger.html#line.20">ResourceSwagger</a></pre> +<div class="block">Extended annotation for <a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#swagger--"><code>@RestResource.swagger()</code></a>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation.type.optional.element.summary"> +<!-- --> +</a> +<h3>Optional Element Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> +<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Optional Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="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/rest/annotation/ResourceSwagger.html#contact--">contact</a></span></code> +<div class="block">Optional contact information for the exposed API.</div> +</td> +</tr> +<tr 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/rest/annotation/ResourceSwagger.html#externalDocs--">externalDocs</a></span></code> +<div class="block">Optional external documentation information for the exposed API.</div> +</td> +</tr> +<tr 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/rest/annotation/ResourceSwagger.html#license--">license</a></span></code> +<div class="block">Optional license information for the exposed API.</div> +</td> +</tr> +<tr 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/rest/annotation/ResourceSwagger.html#tags--">tags</a></span></code> +<div class="block">Optional tagging information for the exposed API.</div> +</td> +</tr> +<tr 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/rest/annotation/ResourceSwagger.html#termsOfService--">termsOfService</a></span></code> +<div class="block">Optional servlet terms-of-service for this API.</div> +</td> +</tr> +<tr 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/rest/annotation/ResourceSwagger.html#version--">version</a></span></code> +<div class="block">Provides the version of the application API (not to be confused with the specification version).</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation.type.element.detail"> +<!-- --> +</a> +<h3>Element Detail</h3> +<a name="termsOfService--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>termsOfService</h4> +<pre>public abstract <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/rest/annotation/ResourceSwagger.html#line.35">termsOfService</a></pre> +<div class="block">Optional servlet terms-of-service for this API. + <p> + It is used to populate the Swagger terms-of-service field. + <p> + The default value pulls the description from the <code>termsOfService</code> entry in the servlet resource bundle. + (e.g. <js>"termsOfService = foo"</js> or <js>"MyServlet.termsOfService = foo"</js>). + <p> + This field can contain variables (e.g. "$L{my.localized.variable}"). + <p> + Corresponds to the swagger field <code>/info/termsOfService</code>. + <p> + The programmatic equivalent to this annotation is the <a href="../../../../../org/apache/juneau/rest/RestInfoProvider.html#getTermsOfService-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getTermsOfService(RestRequest)</code></a> method.</div> +<dl> +<dt>Default:</dt> +<dd>""</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="contact--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>contact</h4> +<pre>public abstract <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/rest/annotation/ResourceSwagger.html#line.69">contact</a></pre> +<div class="block">Optional contact information for the exposed API. + <p> + It is used to populate the Swagger contact field and to display on HTML pages. + <p> + A simplified JSON string with the following fields: + <p class='bcode'> + { + name: string, + url: string, + email: string + } + </p> + <p> + The default value pulls the description from the <code>contact</code> entry in the servlet resource bundle. + (e.g. <js>"contact = {name:'John Smith',email:'[email protected]'}"</js> or <js>"MyServlet.contact = {name:'John Smith',email:'[email protected]'}"</js>). + + <h5 class='section'>Example:</h5> + <p class='bcode'> + <ja>@RestResource</ja>( + swagger=<ja>@MethodSwagger</ja>( + contact=<js>"{name:'John Smith',email:'[email protected]'}"</js> + ) + ) + </p> + <p> + This field can contain variables (e.g. "$L{my.localized.variable}"). + <p> + Corresponds to the swagger field <code>/info/contact</code>. + <p> + The programmatic equivalent to this annotation is the <a href="../../../../../org/apache/juneau/rest/RestInfoProvider.html#getContact-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getContact(RestRequest)</code></a> method.</div> +<dl> +<dt>Default:</dt> +<dd>""</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="license--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>license</h4> +<pre>public abstract <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/rest/annotation/ResourceSwagger.html#line.102">license</a></pre> +<div class="block">Optional license information for the exposed API. + <p> + It is used to populate the Swagger license field and to display on HTML pages. + <p> + A simplified JSON string with the following fields: + <p class='bcode'> + { + name: string, + url: string + } + </p> + <p> + The default value pulls the description from the <code>license</code> entry in the servlet resource bundle. + (e.g. <js>"license = {name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}"</js> or <js>"MyServlet.license = {name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}"</js>). + + <h5 class='section'>Example:</h5> + <p class='bcode'> + <ja>@RestResource</ja>( + swagger=<ja>@MethodSwagger</ja>( + license=<js>"{name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}"</js> + ) + ) + </p> + <p> + This field can contain variables (e.g. "$L{my.localized.variable}"). + <p> + Corresponds to the swagger field <code>/info/license</code>. + <p> + The programmatic equivalent to this annotation is the <a href="../../../../../org/apache/juneau/rest/RestInfoProvider.html#getLicense-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getLicense(RestRequest)</code></a> method.</div> +<dl> +<dt>Default:</dt> +<dd>""</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="version--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>version</h4> +<pre>public abstract <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/rest/annotation/ResourceSwagger.html#line.118">version</a></pre> +<div class="block">Provides the version of the application API (not to be confused with the specification version). + <p> + It is used to populate the Swagger version field and to display on HTML pages. + <p> + The default value pulls the description from the <code>version</code> entry in the servlet resource bundle. + (e.g. <js>"version = 2.0"</js> or <js>"MyServlet.version = 2.0"</js>). + <p> + This field can contain variables (e.g. "$L{my.localized.variable}"). + <p> + Corresponds to the swagger field <code>/info/version</code>. + <p> + The programmatic equivalent to this annotation is the <a href="../../../../../org/apache/juneau/rest/RestInfoProvider.html#getVersion-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getVersion(RestRequest)</code></a> method.</div> +<dl> +<dt>Default:</dt> +<dd>""</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="tags--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>tags</h4> +<pre>public abstract <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/rest/annotation/ResourceSwagger.html#line.157">tags</a></pre> +<div class="block">Optional tagging information for the exposed API. + <p> + It is used to populate the Swagger tags field and to display on HTML pages. + <p> + A simplified JSON string with the following fields: + <p class='bcode'> + [ + { + name: string, + description: string, + externalDocs: { + description: string, + url: string + } + } + ] + </p> + <p> + The default value pulls the description from the <code>tags</code> entry in the servlet resource bundle. + (e.g. <js>"tags = [{name:'Foo',description:'Foobar'}]"</js> or <js>"MyServlet.tags = [{name:'Foo',description:'Foobar'}]"</js>). + + <h5 class='section'>Example:</h5> + <p class='bcode'> + <ja>@RestResource</ja>( + swagger=<ja>@MethodSwagger</ja>( + tags=<js>"[{name:'Foo',description:'Foobar'}]"</js> + ) + ) + </p> + <p> + This field can contain variables (e.g. "$L{my.localized.variable}"). + <p> + Corresponds to the swagger field <code>/tags</code>. + <p> + The programmatic equivalent to this annotation is the <a href="../../../../../org/apache/juneau/rest/RestInfoProvider.html#getTags-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getTags(RestRequest)</code></a> method.</div> +<dl> +<dt>Default:</dt> +<dd>""</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="externalDocs--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>externalDocs</h4> +<pre>public abstract <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/rest/annotation/ResourceSwagger.html#line.190">externalDocs</a></pre> +<div class="block">Optional external documentation information for the exposed API. + <p> + It is used to populate the Swagger external documentation field and to display on HTML pages. + <p> + A simplified JSON string with the following fields: + <p class='bcode'> + { + description: string, + url: string + } + </p> + <p> + The default value pulls the description from the <code>externalDocs</code> entry in the servlet resource bundle. + (e.g. <js>"externalDocs = {url:'http://juneau.apache.org'}"</js> or <js>"MyServlet.externalDocs = {url:'http://juneau.apache.org'}"</js>). + + <h5 class='section'>Example:</h5> + <p class='bcode'> + <ja>@RestResource</ja>( + swagger=<ja>@MethodSwagger</ja>( + externalDocs=<js>"{url:'http://juneau.apache.org'}"</js> + ) + ) + </p> + <p> + This field can contain variables (e.g. "$L{my.localized.variable}"). + <p> + Corresponds to the swagger field <code>/tags</code>. + <p> + The programmatic equivalent to this annotation is the <a href="../../../../../org/apache/juneau/rest/RestInfoProvider.html#getExternalDocs-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getExternalDocs(RestRequest)</code></a> method.</div> +<dl> +<dt>Default:</dt> +<dd>""</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/juneau/rest/annotation/Query.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/juneau/rest/annotation/Response.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/juneau/rest/annotation/ResourceSwagger.html" target="_top">Frames</a></li> +<li><a href="ResourceSwagger.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Field | </li> +<li>Required | </li> +<li><a href="#annotation.type.optional.element.summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#annotation.type.element.detail">Element</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2017 <a href="http://www.apache.org/";>Apache</a>. All rights reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/017373e3/content/site/apidocs/org/apache/juneau/rest/annotation/Response.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/Response.html b/content/site/apidocs/org/apache/juneau/rest/annotation/Response.html index 4ff5971..e22b333 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/Response.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/Response.html @@ -42,7 +42,7 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/juneau/rest/annotation/Query.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/juneau/rest/annotation/ResourceSwagger.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> @@ -96,18 +96,20 @@ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true"; title="class or interface in java.lang.annotation">@Target</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true#value--"; title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#PARAMETER"; title="class or interface in java.lang.annotation">PARAMETER</a>) <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true"; title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true#value--"; title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME"; title="class or interface in java.lang.annotation">RUNTIME</a>) <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Inherited.html?is-external=true"; title="class or interface in java.lang.annotation">@Inherited</a> -public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annotation/Response.html#line.42">Response</a></pre> -<div class="block">Annotation used in conjunction with <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#responses--"><code>RestMethod.responses()</code></a> to identify possible responses by the method. +public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annotation/Response.html#line.44">Response</a></pre> +<div class="block">Annotation used in conjunction with <a href="../../../../../org/apache/juneau/rest/annotation/MethodSwagger.html#responses--"><code>MethodSwagger.responses()</code></a> to identify possible responses by the method. <h5 class='section'>Example:</h5> <p class='bcode'> <ja>@RestMethod</ja>( name=<js>"*"</js>, - responses={ - <ja>@Response</ja>(value=200,description=<js>"Everything was great."</js>), - <ja>@Response</ja>(value=404,description=<js>"File was not found."</js>) - <ja>@Response</ja>(500), - } + swagger=@ResourceSwagger( + responses={ + <ja>@Response</ja>(value=200,description=<js>"Everything was great."</js>), + <ja>@Response</ja>(value=404,description=<js>"File was not found."</js>) + <ja>@Response</ja>(500), + } + ) ) <jk>public void</jk> doAnything(RestRequest req, RestResponse res, <ja>@Method</ja> String method) { ... @@ -191,7 +193,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockListLast"> <li class="blockList"> <h4>value</h4> -<pre>public abstract int <a href="../../../../../src-html/org/apache/juneau/rest/annotation/Response.html#line.47">value</a></pre> +<pre>public abstract int <a href="../../../../../src-html/org/apache/juneau/rest/annotation/Response.html#line.49">value</a></pre> <div class="block">HTTP response code.</div> </li> </ul> @@ -205,7 +207,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>description</h4> -<pre>public abstract <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/rest/annotation/Response.html#line.59">description</a></pre> +<pre>public abstract <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/rest/annotation/Response.html#line.61">description</a></pre> <div class="block">Optional description. <p> The default value pulls the description from the <code>description</code> entry in the servlet resource bundle. @@ -229,7 +231,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>schema</h4> -<pre>public abstract <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/rest/annotation/Response.html#line.78">schema</a></pre> +<pre>public abstract <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/rest/annotation/Response.html#line.82">schema</a></pre> <div class="block">A definition of the response structure. <p> It can be a primitive, an array or an object. @@ -241,9 +243,11 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <p class='bcode'> <ja>@RestMethod</ja>( name=<js>"*"</js>, - responses={ - <ja>@Response</ja>(value=200,schema=<js>"{type:'string',description:'A serialized Person bean.'}"</js>), - } + swagger=@MethodSwagger( + responses={ + <ja>@Response</ja>(value=200,schema=<js>"{type:'string',description:'A serialized Person bean.'}"</js>), + } + ) </p></div> <dl> <dt>Default:</dt> @@ -260,7 +264,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockListLast"> <li class="blockList"> <h4>headers</h4> -<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/Parameter.html" title="annotation in org.apache.juneau.rest.annotation">Parameter</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/Response.html#line.86">headers</a></pre> +<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/Parameter.html" title="annotation in org.apache.juneau.rest.annotation">Parameter</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/Response.html#line.90">headers</a></pre> <div class="block">Optional response headers. <p> Response variables can also be defined in the servlet resource bundle. @@ -298,7 +302,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/juneau/rest/annotation/Query.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/juneau/rest/annotation/ResourceSwagger.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/017373e3/content/site/apidocs/org/apache/juneau/rest/annotation/RestMethod.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/RestMethod.html b/content/site/apidocs/org/apache/juneau/rest/annotation/RestMethod.html index 77afb53..3e99971 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/RestMethod.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/RestMethod.html @@ -96,7 +96,7 @@ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true"; title="class or interface in java.lang.annotation">@Target</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true#value--"; title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD"; title="class or interface in java.lang.annotation">METHOD</a>) <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true"; title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true#value--"; title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME"; title="class or interface in java.lang.annotation">RUNTIME</a>) <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Inherited.html?is-external=true"; title="class or interface in java.lang.annotation">@Inherited</a> -public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.35">RestMethod</a></pre> +public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.36">RestMethod</a></pre> <div class="block">Identifies a REST Java method on a <a href="../../../../../org/apache/juneau/rest/RestServlet.html" title="class in org.apache.juneau.rest"><code>RestServlet</code></a> implementation class. <p> Refer to <a class='doclink' href='../package-summary.html#TOC'>org.apache.juneau.rest</a> doc for information on using this class.</div> @@ -155,29 +155,17 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota </td> </tr> <tr class="altColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#deprecated--">deprecated</a></span></code> -<div class="block">Optional deprecated flag for the exposed API.</div> -</td> -</tr> -<tr 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/rest/annotation/RestMethod.html#description--">description</a></span></code> <div class="block">Optional description for the exposed API.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/encoders/Encoder.html" title="class in org.apache.juneau.encoders">Encoder</a>>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#encoders--">encoders</a></span></code> <div class="block">Appends to the list of <a href="../../../../../org/apache/juneau/encoders/Encoder.html" title="class in org.apache.juneau.encoders"><code>encoders</code></a> specified on the servlet.</div> </td> </tr> -<tr 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/rest/annotation/RestMethod.html#externalDocs--">externalDocs</a></span></code> -<div class="block">Optional external documentation information for the exposed API.</div> -</td> -</tr> <tr class="altColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestGuard.html" title="class in org.apache.juneau.rest">RestGuard</a>>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#guards--">guards</a></span></code> @@ -185,89 +173,65 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota </td> </tr> <tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html" title="annotation in org.apache.juneau.rest.annotation">HtmlDoc</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#htmldoc--">htmldoc</a></span></code> +<div class="block">Provides HTML-doc-specific metadata on this method.</div> +</td> +</tr> +<tr class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#inheritEncoders--">inheritEncoders</a></span></code> <div class="block">Specifies whether the method should inherit encoders from the servlet.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestMatcher.html" title="class in org.apache.juneau.rest">RestMatcher</a>>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#matchers--">matchers</a></span></code> <div class="block">Method matchers.</div> </td> </tr> -<tr class="rowColor"> +<tr 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/rest/annotation/RestMethod.html#name--">name</a></span></code> <div class="block">REST method name.</div> </td> </tr> -<tr 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/rest/annotation/RestMethod.html#pageLinks--">pageLinks</a></span></code> -<div class="block">Overrides the HTML page links defined on the servlet via the <a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#pageLinks--"><code>@RestResource.pageLinks()</code></a> annotation.</div> -</td> -</tr> <tr 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/rest/annotation/RestMethod.html#pageText--">pageText</a></span></code> -<div class="block">Overrides the HTML page text defined on the servlet via the <a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#pageText--"><code>@RestResource.pageText()</code></a> annotation.</div> -</td> -</tr> -<tr 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/rest/annotation/RestMethod.html#pageTitle--">pageTitle</a></span></code> -<div class="block">Overrides the HTML page title defined on the servlet via the <a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#pageTitle--"><code>@RestResource.pageTitle()</code></a> annotation.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/annotation/Parameter.html" title="annotation in org.apache.juneau.rest.annotation">Parameter</a>[]</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#parameters--">parameters</a></span></code> -<div class="block">Optional parameter descriptions.</div> -</td> -</tr> -<tr class="altColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/parser/Parser.html" title="class in org.apache.juneau.parser">Parser</a>>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#parsers--">parsers</a></span></code> <div class="block">Overrides the list of parsers assigned at the method level.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/annotation/Inherit.html" title="enum in org.apache.juneau.rest.annotation">Inherit</a>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#parsersInherit--">parsersInherit</a></span></code> <div class="block">Used in conjunction with <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#parsers--"><code>parsers()</code></a> to identify what class-level settings are inherited by the method parser group.</div> </td> </tr> -<tr class="altColor"> +<tr 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/rest/annotation/RestMethod.html#path--">path</a></span></code> <div class="block">Optional path pattern for the specified method.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#pojoSwaps--">pojoSwaps</a></span></code> <div class="block">Appends the specified POJO swaps to all serializers and parsers used by this method.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#priority--">priority</a></span></code> <div class="block">URL path pattern priority.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/annotation/Property.html" title="annotation in org.apache.juneau.rest.annotation">Property</a>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#properties--">properties</a></span></code> <div class="block">Same as <a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#properties--"><code>RestResource.properties()</code></a>, except defines property values by default when this method is called.</div> </td> </tr> -<tr class="altColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/annotation/Response.html" title="annotation in org.apache.juneau.rest.annotation">Response</a>[]</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#responses--">responses</a></span></code> -<div class="block">Optional output description.</div> -</td> -</tr> <tr class="rowColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a>>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#serializers--">serializers</a></span></code> @@ -287,9 +251,16 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota </td> </tr> <tr 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/rest/annotation/RestMethod.html#tags--">tags</a></span></code> -<div class="block">Optional tagging information for the exposed API.</div> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/annotation/MethodSwagger.html" title="annotation in org.apache.juneau.rest.annotation">MethodSwagger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#swagger--">swagger</a></span></code> +<div class="block">Provides swagger-specific metadata on this method.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/widget/Widget.html" title="class in org.apache.juneau.rest.widget">Widget</a>>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#widgets--">widgets</a></span></code> +<div class="block">Defines widgets that can be used in conjunction with string variables of the form <js>"$W{name}"</js>to quickly + generate arbitrary replacement text.</div> </td> </tr> </table> @@ -313,7 +284,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>name</h4> -<pre>public abstract <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/rest/annotation/RestMethod.html#line.64">name</a></pre> +<pre>public abstract <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/rest/annotation/RestMethod.html#line.65">name</a></pre> <div class="block">REST method name. <p> Typically <js>"GET"</js>, <js>"PUT"</js>, <js>"POST"</js>, <js>"DELETE"</js>, or <js>"OPTIONS"</js>. @@ -354,7 +325,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>path</h4> -<pre>public abstract <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/rest/annotation/RestMethod.html#line.84">path</a></pre> +<pre>public abstract <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/rest/annotation/RestMethod.html#line.85">path</a></pre> <div class="block">Optional path pattern for the specified method. <p> Appending <js>"/*"</js> to the end of the path pattern will make it match any remainder too.<br> @@ -386,7 +357,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>priority</h4> -<pre>public abstract int <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.94">priority</a></pre> +<pre>public abstract int <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.95">priority</a></pre> <div class="block">URL path pattern priority. <p> To force path patterns to be checked before other path patterns, use a higher priority number. @@ -408,7 +379,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>guards</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestGuard.html" title="class in org.apache.juneau.rest">RestGuard</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.105">guards</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestGuard.html" title="class in org.apache.juneau.rest">RestGuard</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.106">guards</a></pre> <div class="block">Method guards. <p> Associates one or more <a href="../../../../../org/apache/juneau/rest/RestGuard.html" title="class in org.apache.juneau.rest"><code>RestGuards</code></a> with a method call. @@ -431,7 +402,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>converters</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestConverter.html" title="interface in org.apache.juneau.rest">RestConverter</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.118">converters</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestConverter.html" title="interface in org.apache.juneau.rest">RestConverter</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.119">converters</a></pre> <div class="block">Method response converters. <p> Associates one or more <a href="../../../../../org/apache/juneau/rest/RestConverter.html" title="interface in org.apache.juneau.rest"><code>RestConverters</code></a> with a method call. @@ -456,7 +427,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>matchers</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestMatcher.html" title="class in org.apache.juneau.rest">RestMatcher</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.130">matchers</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestMatcher.html" title="class in org.apache.juneau.rest">RestMatcher</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.131">matchers</a></pre> <div class="block">Method matchers. <p> Associates one more more <a href="../../../../../org/apache/juneau/rest/RestMatcher.html" title="class in org.apache.juneau.rest"><code>RestMatchers</code></a> with this method. @@ -480,7 +451,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>serializers</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.154">serializers</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.155">serializers</a></pre> <div class="block">Overrides the list of serializers assigned at the method level. <p> Use this annotation when the list of serializers assigned to a method differs from the list of serializers assigned at the servlet level. @@ -516,7 +487,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>serializersInherit</h4> -<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/Inherit.html" title="enum in org.apache.juneau.rest.annotation">Inherit</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.176">serializersInherit</a></pre> +<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/Inherit.html" title="enum in org.apache.juneau.rest.annotation">Inherit</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.177">serializersInherit</a></pre> <div class="block">Used in conjunction with <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#serializers--"><code>serializers()</code></a> to identify what class-level settings are inherited by the method serializer group. <p> Possible values: @@ -550,7 +521,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>parsers</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/parser/Parser.html" title="class in org.apache.juneau.parser">Parser</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.200">parsers</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/parser/Parser.html" title="class in org.apache.juneau.parser">Parser</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.201">parsers</a></pre> <div class="block">Overrides the list of parsers assigned at the method level. <p> Use this annotation when the list of parsers assigned to a method differs from the list of parsers assigned at the servlet level. @@ -586,7 +557,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>parsersInherit</h4> -<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/Inherit.html" title="enum in org.apache.juneau.rest.annotation">Inherit</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.221">parsersInherit</a></pre> +<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/Inherit.html" title="enum in org.apache.juneau.rest.annotation">Inherit</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.222">parsersInherit</a></pre> <div class="block">Used in conjunction with <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#parsers--"><code>parsers()</code></a> to identify what class-level settings are inherited by the method parser group. <p> Possible values: @@ -619,7 +590,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>encoders</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/encoders/Encoder.html" title="class in org.apache.juneau.encoders">Encoder</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.246">encoders</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/encoders/Encoder.html" title="class in org.apache.juneau.encoders">Encoder</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.247">encoders</a></pre> <div class="block">Appends to the list of <a href="../../../../../org/apache/juneau/encoders/Encoder.html" title="class in org.apache.juneau.encoders"><code>encoders</code></a> specified on the servlet. <p> Use this annotation when the list of encoders assigned to a method differs from the list of encoders assigned at the servlet level. @@ -656,7 +627,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>inheritEncoders</h4> -<pre>public abstract boolean <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.251">inheritEncoders</a></pre> +<pre>public abstract boolean <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.252">inheritEncoders</a></pre> <div class="block">Specifies whether the method should inherit encoders from the servlet.</div> <dl> <dt>Default:</dt> @@ -673,7 +644,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>properties</h4> -<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/Property.html" title="annotation in org.apache.juneau.rest.annotation">Property</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.258">properties</a></pre> +<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/Property.html" title="annotation in org.apache.juneau.rest.annotation">Property</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.259">properties</a></pre> <div class="block">Same as <a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#properties--"><code>RestResource.properties()</code></a>, except defines property values by default when this method is called. <p> This is equivalent to simply calling <code>res.addProperties()</code> in the Java method, but is provided for convenience.</div> @@ -692,7 +663,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>beanFilters</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.263">beanFilters</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.264">beanFilters</a></pre> <div class="block">Appends the specified bean filters to all serializers and parsers used by this method.</div> <dl> <dt>Default:</dt> @@ -709,7 +680,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>pojoSwaps</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.268">pojoSwaps</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.269">pojoSwaps</a></pre> <div class="block">Appends the specified POJO swaps to all serializers and parsers used by this method.</div> <dl> <dt>Default:</dt> @@ -726,7 +697,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>defaultRequestHeaders</h4> -<pre>public abstract <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/rest/annotation/RestMethod.html#line.296">defaultRequestHeaders</a></pre> +<pre>public abstract <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/rest/annotation/RestMethod.html#line.297">defaultRequestHeaders</a></pre> <div class="block">Specifies default values for request headers. <p> Strings are of the format <js>"Header-Name: header-value"</js>. @@ -766,7 +737,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>defaultQuery</h4> -<pre>public abstract <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/rest/annotation/RestMethod.html#line.316">defaultQuery</a></pre> +<pre>public abstract <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/rest/annotation/RestMethod.html#line.317">defaultQuery</a></pre> <div class="block">Specifies default values for query parameters. <p> Strings are of the format <js>"name=value"</js>. @@ -798,7 +769,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>defaultFormData</h4> -<pre>public abstract <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/rest/annotation/RestMethod.html#line.336">defaultFormData</a></pre> +<pre>public abstract <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/rest/annotation/RestMethod.html#line.337">defaultFormData</a></pre> <div class="block">Specifies default values for form-data parameters. <p> Strings are of the format <js>"name=value"</js>. @@ -830,7 +801,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>summary</h4> -<pre>public abstract <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/rest/annotation/RestMethod.html#line.355">summary</a></pre> +<pre>public abstract <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/rest/annotation/RestMethod.html#line.356">summary</a></pre> <div class="block">Optional summary for the exposed API. <p> This summary is used in the following locations: @@ -861,7 +832,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>description</h4> -<pre>public abstract <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/rest/annotation/RestMethod.html#line.374">description</a></pre> +<pre>public abstract <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/rest/annotation/RestMethod.html#line.375">description</a></pre> <div class="block">Optional description for the exposed API. <p> This description is used in the following locations: @@ -886,214 +857,13 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota </li> </ul> <ul class="blockList"> -<li class="blockList"><a name="externalDocs--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>externalDocs</h4> -<pre>public abstract <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/rest/annotation/RestMethod.html#line.401">externalDocs</a></pre> -<div class="block">Optional external documentation information for the exposed API. - <p> - Used to populate the Swagger external documentation field. - <p> - A simplified JSON string with the following fields: - <p class='bcode'> - { - description: string, - url: string - } - </p> - <p> - The default value pulls the description from the <code>(className.?)[javaMethodName].externalDocs</code> entry in the servlet resource bundle. - (e.g. <js>"MyClass.myMethod.externalDocs = {url:'http://juneau.apache.org'}"</js> or <js>"myMethod.externalDocs = {url:'http://juneau.apache.org'}"</js>). - - <h5 class='section'>Example:</h5> - <p class='bcode'> - <ja>@RestMethod</ja>(externalDocs=<js>"{url:'http://juneau.apache.org'}"</js>) - </p> - <p> - This field can contain variables (e.g. "$L{my.localized.variable}"). - <p> - Corresponds to the swagger field <code>/paths/{path}/{method}/externalDocs</code>.</div> -<dl> -<dt>Default:</dt> -<dd>""</dd> -</dl> -</li> -</ul> -</li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="tags--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>tags</h4> -<pre>public abstract <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/rest/annotation/RestMethod.html#line.423">tags</a></pre> -<div class="block">Optional tagging information for the exposed API. - <p> - Used to populate the Swagger tags field. - <p> - A comma-delimited list of tags for API documentation control. - Tags can be used for logical grouping of operations by resources or any other qualifier. - <p> - The default value pulls the description from the <code>(className.?)[javaMethodName].tags</code> entry in the servlet resource bundle. - (e.g. <js>"MyClass.myMethod.tags = foo,bar"</js> or <js>"myMethod.tags = foo,bar"</js>). - - <h5 class='section'>Example:</h5> - <p class='bcode'> - <ja>@RestMethod</ja>(tags=<js>"foo,bar"</js>) - </p> - <p> - This field can contain variables (e.g. "$L{my.localized.variable}"). - <p> - Corresponds to the swagger field <code>/paths/{path}/{method}/tags</code>.</div> -<dl> -<dt>Default:</dt> -<dd>""</dd> -</dl> -</li> -</ul> -</li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="deprecated--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>deprecated</h4> -<pre>public abstract boolean <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.442">deprecated</a></pre> -<div class="block">Optional deprecated flag for the exposed API. - <p> - Used to populate the Swagger deprecated field. - <p> - The default value pulls the description from the <code>(className.?)[javaMethodName].deprecated</code> entry in the servlet resource bundle. - (e.g. <js>"MyClass.myMethod.deprecated = true"</js> or <js>"myMethod.deprecated = foo,bar"</js>). - - <h5 class='section'>Example:</h5> - <p class='bcode'> - <ja>@RestMethod</ja>(deprecated=<jk>true</jk>) - </p> - <p> - This field can contain variables (e.g. "$L{my.localized.variable}"). - <p> - Corresponds to the swagger field <code>/paths/{path}/{method}/deprecated</code>.</div> -<dl> -<dt>Default:</dt> -<dd>false</dd> -</dl> -</li> -</ul> -</li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="parameters--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>parameters</h4> -<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/Parameter.html" title="annotation in org.apache.juneau.rest.annotation">Parameter</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.479">parameters</a></pre> -<div class="block">Optional parameter descriptions. - <p> - This annotation is provided for documentation purposes and is used to populate the method <js>"parameters"</js> column - on the Swagger page. - - <h5 class='section'>Example:</h5> - <p class='bcode'> - <ja>@RestMethod</ja>( - name=<js>"POST"</js>, path=<js>"/{a}"</js>, - description=<js>"This is my method."</js>, - parameters={ - <ja>@Parameter</ja>(in=<js>"path"</js>, name=<js>"a"</js>, description=<js>"The 'a' attribute"</js>), - <ja>@Parameter</ja>(in=<js>"query"</js>, name=<js>"b"</js>, description=<js>"The 'b' parameter"</js>, required=<jk>true</jk>), - <ja>@Parameter</ja>(in=<js>"body"</js>, description=<js>"The HTTP content"</js>), - <ja>@Parameter</ja>(in=<js>"header"</js>, name=<js>"D"</js>, description=<js>"The 'D' header"</js>), - } - ) - </p> - This is functionally equivalent to specifying the following keys in the resource bundle for the class, except in this case - the strings are internationalized. - <p class='bcode'> - <jk>MyClass.myMethod.description</jk> = <js>This is my method.</js> - <jk>MyClass.myMethod.req.path.a.description</jk> = <js>The 'a' attribute</js> - <jk>MyClass.myMethod.req.query.b.description</jk> = <js>The 'b' parameter</js> - <jk>MyClass.myMethod.req.body.description</jk> = <js>The HTTP content</js> - <jk>MyClass.myMethod.req.header.d.description</jk> = <js>The 'D' header</js> - <p> - As a general rule, use annotations when you don't care about internationalization (i.e. you only want to support English), - and use resource bundles if you need to support localization. - <p> - These annotations can contain variables (e.g. "$L{my.localized.variable}"). - <p> - Corresponds to the swagger field <code>/paths/{path}/{method}/parameters</code>.</div> -<dl> -<dt>Default:</dt> -<dd>{}</dd> -</dl> -</li> -</ul> -</li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="responses--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>responses</h4> -<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/Response.html" title="annotation in org.apache.juneau.rest.annotation">Response</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.515">responses</a></pre> -<div class="block">Optional output description. - <p> - This annotation is provided for documentation purposes and is used to populate the method <js>"responses"</js> column - on the Swagger page. - - <h5 class='section'>Example:</h5> - <p class='bcode'> - <ja>@RestMethod</ja>( - name=<js>"GET"</js>, path=<js>"/"</js>, - responses={ - <ja>@Response</ja>(200), - <ja>@Response</ja>( - value=302, - description=<js>"Thing wasn't found here"</js>, - headers={ - <ja>@Parameter</ja>(name=<js>"Location"</js>, description=<js>"The place to find the thing"</js>) - } - ) - } - ) - </p> - This is functionally equivalent to specifying the following keys in the resource bundle for the class, except in this case - the strings are internationalized. - <p class='bcode'> - <jk>MyClass.myMethod.res.200.description</jk> = <js>OK</js> - <jk>MyClass.myMethod.res.302.description</jk> = <js>Thing wasn't found here</js> - <jk>MyClass.myMethod.res.302.header.Location.description</jk> = <js>The place to find the thing</js> - <p> - As a general rule, use annotations when you don't care about internationalization (i.e. you only want to support English), - and use resource bundles if you need to support localization. - <p> - These annotations can contain variables (e.g. "$L{my.localized.variable}").</div> -<dl> -<dt>Default:</dt> -<dd>{}</dd> -</dl> -</li> -</ul> -</li> -</ul> -<ul class="blockList"> <li class="blockList"><a name="clientVersion--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>clientVersion</h4> -<pre>public abstract <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/rest/annotation/RestMethod.html#line.573">clientVersion</a></pre> +<pre>public abstract <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/rest/annotation/RestMethod.html#line.433">clientVersion</a></pre> <div class="block">Specifies whether this method can be called based on the client version. <p> The client version is identified via the HTTP request header identified by <a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#clientVersionHeader--"><code>RestResource.clientVersionHeader()</code></a> which @@ -1157,51 +927,56 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota </li> </ul> <ul class="blockList"> -<li class="blockList"><a name="pageTitle--"> +<li class="blockList"><a name="widgets--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>pageTitle</h4> -<pre>public abstract <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/rest/annotation/RestMethod.html#line.578">pageTitle</a></pre> -<div class="block">Overrides the HTML page title defined on the servlet via the <a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#pageTitle--"><code>@RestResource.pageTitle()</code></a> annotation.</div> +<h4>widgets</h4> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/widget/Widget.html" title="class in org.apache.juneau.rest.widget">Widget</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.441">widgets</a></pre> +<div class="block">Defines widgets that can be used in conjunction with string variables of the form <js>"$W{name}"</js>to quickly + generate arbitrary replacement text. + <p> + Widgets are inherited from parent to child, but can be overridden by reusing the widget name.</div> <dl> <dt>Default:</dt> -<dd>""</dd> +<dd>{}</dd> </dl> </li> </ul> </li> </ul> <ul class="blockList"> -<li class="blockList"><a name="pageText--"> +<li class="blockList"><a name="swagger--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>pageText</h4> -<pre>public abstract <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/rest/annotation/RestMethod.html#line.583">pageText</a></pre> -<div class="block">Overrides the HTML page text defined on the servlet via the <a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#pageText--"><code>@RestResource.pageText()</code></a> annotation.</div> +<h4>swagger</h4> +<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/MethodSwagger.html" title="annotation in org.apache.juneau.rest.annotation">MethodSwagger</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.446">swagger</a></pre> +<div class="block">Provides swagger-specific metadata on this method.</div> <dl> <dt>Default:</dt> -<dd>""</dd> +<dd>@org.apache.juneau.rest.annotation.MethodSwagger</dd> </dl> </li> </ul> </li> </ul> <ul class="blockList"> -<li class="blockList"><a name="pageLinks--"> +<li class="blockList"><a name="htmldoc--"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> -<h4>pageLinks</h4> -<pre>public abstract <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/rest/annotation/RestMethod.html#line.588">pageLinks</a></pre> -<div class="block">Overrides the HTML page links defined on the servlet via the <a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#pageLinks--"><code>@RestResource.pageLinks()</code></a> annotation.</div> +<h4>htmldoc</h4> +<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html" title="annotation in org.apache.juneau.rest.annotation">HtmlDoc</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.453">htmldoc</a></pre> +<div class="block">Provides HTML-doc-specific metadata on this method. + <p> + Information provided here overrides information provided in the servlet-level annotation.</div> <dl> <dt>Default:</dt> -<dd>""</dd> +<dd>@org.apache.juneau.rest.annotation.HtmlDoc</dd> </dl> </li> </ul>
