http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/017373e3/content/site/apidocs/org/apache/juneau/rest/annotation/HtmlDoc.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/HtmlDoc.html b/content/site/apidocs/org/apache/juneau/rest/annotation/HtmlDoc.html new file mode 100644 index 0000000..0eaa5c4 --- /dev/null +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/HtmlDoc.html @@ -0,0 +1,727 @@ +<!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>HtmlDoc (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="HtmlDoc (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/Header.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/Inherit.html" title="enum 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/HtmlDoc.html" target="_top">Frames</a></li> +<li><a href="HtmlDoc.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 HtmlDoc" class="title">Annotation Type HtmlDoc</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/HtmlDoc.html#line.72">HtmlDoc</a></pre> +<div class="block">Contains all the configurable annotations for the <a href="../../../../../org/apache/juneau/html/HtmlDocSerializer.html" title="class in org.apache.juneau.html"><code>HtmlDocSerializer</code></a>. + <p> + Used with <a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#htmldoc--"><code>RestResource.htmldoc()</code></a> and <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#htmldoc--"><code>RestMethod.htmldoc()</code></a> to customize the HTML view of + serialized POJOs. + <p> + All annotations specified here have no effect on any serializers other than <a href="../../../../../org/apache/juneau/html/HtmlDocSerializer.html" title="class in org.apache.juneau.html"><code>HtmlDocSerializer</code></a> and is + provided as a shorthand method of for specifying configuration properties. + <p> + For example, the following two methods for defining the HTML document title are considered equivalent: + <p class='bcode'> + <ja>@RestResource</ja>( + properties={ + <ja>@Property</ja>(name=<jsf>HTMLDOC_title</jsf>, value=<js>"My Resource Page"</js>) + } + ) + + <ja>@RestResource</ja>( + htmldoc=<ja>@HtmlDoc</ja>( + title=<js>"My Resource Page"</js> + ) + ) + </p> + <p> + The purpose of these annotation is to populate the HTML document view which by default consists of the following + structure: + <p class='bcode'> + <xt><html> + <head> + <style <xa>type</xa>=<xs>'text/css'</xs>> + <xv>CSS styles and links to stylesheets</xv> + </style> + </head> + <body> + <header> + <xv>Page title and description</xv> + </header> + <nav> + <xv>Page links</xv> + </nav> + <aside> + <xv>Side-bar page links</xv> + </aside> + <article> + <xv>Contents of serialized object</xv> + </article> + <footer> + <xv>Footer message</xv> + </footer> + </body> + </html></xt> + </p></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/HtmlDoc.html#aside--">aside</a></span></code> +<div class="block">Sets the HTML aside section contents.</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/HtmlDoc.html#css--">css</a></span></code> +<div class="block">Sets the HTML CSS style section contents.</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/HtmlDoc.html#cssUrl--">cssUrl</a></span></code> +<div class="block">Sets the CSS URL in the HTML CSS style section.</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/HtmlDoc.html#description--">description</a></span></code> +<div class="block">Sets the HTML page description.</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/HtmlDoc.html#footer--">footer</a></span></code> +<div class="block">Sets the HTML footer section contents.</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/HtmlDoc.html#header--">header</a></span></code> +<div class="block">Sets the HTML header section contents.</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/HtmlDoc.html#links--">links</a></span></code> +<div class="block">Sets the links in the HTML nav section.</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/HtmlDoc.html#nav--">nav</a></span></code> +<div class="block">Sets the HTML nav section contents.</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/HtmlDoc.html#noResultsMessage--">noResultsMessage</a></span></code> +<div class="block">Specifies the text to display when serializing an empty array or collection.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#nowrap--">nowrap</a></span></code> +<div class="block">Shorthand method for forcing the rendered HTML content to be no-wrap.</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/html/HtmlDocTemplate.html" title="interface in org.apache.juneau.html">HtmlDocTemplate</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#template--">template</a></span></code> +<div class="block">Specifies the template class to use for rendering the HTML page.</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/HtmlDoc.html#title--">title</a></span></code> +<div class="block">Sets the HTML page title.</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="title--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>title</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/HtmlDoc.html#line.105">title</a></pre> +<div class="block">Sets the HTML page title. + <p> + The format of this value is plain text. + <p> + It gets wrapped in a <code><xt><h3> <xa>class</xa>=<xs>'title'</xs>></xt></code> element and then added + to the <code><xt><header></code> section on the page. + <p> + If not specified, the page title is pulled from one of the following locations: + <ol> + <li><code>{servletClass}.{methodName}.pageTitle</code> resource bundle value. + <li><code>{servletClass}.pageTitle</code> resource bundle value. + <li><code><ja>@RestResource</ja>(title)</code> annotation. + <li><code>{servletClass}.title</code> resource bundle value. + <li><code>info/title</code> entry in swagger file. + <ol> + <p> + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <p> + A value of <js>"NONE"</js> can be used to force no value. + <p> + <ul class='doctree'> + <li class='info'> + In most cases, you'll simply want to use the <code>@RestResource(title)</code> annotation to specify the + page title. + However, this annotation is provided in cases where you want the page title to be different that the one + shown in the swagger document. + </ul> + <p> + The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlTitle-java.lang.String-"><code>RestConfig.setHtmlTitle(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlTitle-java.lang.Object-"><code>RestResponse.setHtmlTitle(Object)</code></a> methods.</div> +<dl> +<dt>Default:</dt> +<dd>""</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="description--"> +<!-- --> +</a> +<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/HtmlDoc.html#line.140">description</a></pre> +<div class="block">Sets the HTML page description. + <p> + The format of this value is plain text. + <p> + It gets wrapped in a <code><xt><h5> <xa>class</xa>=<xs>'description'</xs>></xt></code> element and then + added to the <code><xt><header></code> section on the page. + <p> + If not specified, the page title is pulled from one of the following locations: + <ol> + <li><code>{servletClass}.{methodName}.pageText</code> resource bundle value. + <li><code>{servletClass}.pageText</code> resource bundle value. + <li><code><ja>@RestMethod</ja>(summary)</code> annotation. + <li><code>{servletClass}.{methodName}.summary</code> resource bundle value. + <li><code>summary</code> entry in swagger file for method. + <li><code>{servletClass}.description</code> resource bundle value. + <li><code>info/description</code> entry in swagger file. + <ol> + <p> + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <p> + A value of <js>"NONE"</js> can be used to force no value. + <p> + <ul class='doctree'> + <li class='info'> + In most cases, you'll simply want to use the <code>@RestResource(description)</code> or + <code>@RestMethod(summary)</code> annotations to specify the page text. + However, this annotation is provided in cases where you want the text to be different that the values shown + in the swagger document. + </ul> + <p> + The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlDescription-java.lang.String-"><code>RestConfig.setHtmlDescription(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlDescription-java.lang.Object-"><code>RestResponse.setHtmlDescription(Object)</code></a> methods.</div> +<dl> +<dt>Default:</dt> +<dd>""</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="header--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>header</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/HtmlDoc.html#line.167">header</a></pre> +<div class="block">Sets the HTML header section contents. + <p> + The format of this value is HTML. + <p> + The page header normally contains the title and description, but this value can be used to override the contents + to be whatever you want. + <p> + <h5 class='section'>Example:</h5> + <p class='bcode'> + <ja>@RestResource</ja>( + htmldoc=<ja>@HtmlDoc</ja>( + header=<js>"<p>This is my REST interface</p>"</js> + ) + ) + </p> + <p> + When a value is specified, the <a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#title--"><code>title()</code></a> and <a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#description--"><code>description()</code></a> values will be ignored. + <p> + A value of <js>"NONE"</js> can be used to force no header. + <p> + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <p> + The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlHeader-java.lang.String-"><code>RestConfig.setHtmlHeader(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlHeader-java.lang.Object-"><code>RestResponse.setHtmlHeader(Object)</code></a> methods.</div> +<dl> +<dt>Default:</dt> +<dd>""</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="links--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>links</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/HtmlDoc.html#line.194">links</a></pre> +<div class="block">Sets the links in the HTML nav section. + <p> + The format of this value is a lax-JSON map of key/value pairs where the keys are the link text and the values are + relative (to the servlet) or absolute URLs. + <p> + The page links are positioned immediately under the title and text. + <p> + <h5 class='section'>Example:</h5> + <p class='bcode'> + <ja>@RestResource</ja>( + htmldoc=<ja>@HtmlDoc</ja>( + links=<js>"{up:'request:/..',options:'servlet:/?method=OPTIONS'}"</js> + ) + ) + </p> + <p> + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <p> + A value of <js>"NONE"</js> can be used to force no value. + <p> + This field can also use URIs of any support type in <a href="../../../../../org/apache/juneau/UriResolver.html" title="class in org.apache.juneau"><code>UriResolver</code></a>. + <p> + The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlLinks-java.lang.String-"><code>RestConfig.setHtmlLinks(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlLinks-java.lang.Object-"><code>RestResponse.setHtmlLinks(Object)</code></a> methods.</div> +<dl> +<dt>Default:</dt> +<dd>""</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="nav--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>nav</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/HtmlDoc.html#line.222">nav</a></pre> +<div class="block">Sets the HTML nav section contents. + <p> + The format of this value is HTML. + <p> + The nav section of the page contains the links. + <p> + The format of this value is HTML. + <p> + <h5 class='section'>Example:</h5> + <p class='bcode'> + <ja>@RestResource</ja>( + htmldoc=<ja>@HtmlDoc</ja>( + nav=<js>"<p>Custom nav content</p>"</js> + ) + ) + </p> + <p> + When a value is specified, the <a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#links--"><code>links()</code></a> value will be ignored. + <p> + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <p> + A value of <js>"NONE"</js> can be used to force no value. + <p> + The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlNav-java.lang.String-"><code>RestConfig.setHtmlNav(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlNav-java.lang.Object-"><code>RestResponse.setHtmlNav(Object)</code></a> methods.</div> +<dl> +<dt>Default:</dt> +<dd>""</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="aside--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>aside</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/HtmlDoc.html#line.246">aside</a></pre> +<div class="block">Sets the HTML aside section contents. + <p> + The format of this value is HTML. + <p> + The aside section typically floats on the right side of the page. + <p> + <h5 class='section'>Example:</h5> + <p class='bcode'> + <ja>@RestResource</ja>( + htmldoc=<ja>@HtmlDoc</ja>( + aside=<js>"<p>Custom aside content</p>"</js> + ) + ) + </p> + <p> + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <p> + A value of <js>"NONE"</js> can be used to force no value. + <p> + The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlAside-java.lang.String-"><code>RestConfig.setHtmlAside(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlAside-java.lang.Object-"><code>RestResponse.setHtmlAside(Object)</code></a> methods.</div> +<dl> +<dt>Default:</dt> +<dd>""</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="footer--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>footer</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/HtmlDoc.html#line.270">footer</a></pre> +<div class="block">Sets the HTML footer section contents. + <p> + The format of this value is HTML. + <p> + The footer section typically floats on the bottom of the page. + <p> + <h5 class='section'>Example:</h5> + <p class='bcode'> + <ja>@RestResource</ja>( + htmldoc=<ja>@HtmlDoc</ja>( + footer=<js>"<p>Custom footer content</p>"</js> + ) + ) + </p> + <p> + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <p> + A value of <js>"NONE"</js> can be used to force no value. + <p> + The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlFooter-java.lang.String-"><code>RestConfig.setHtmlFooter(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlFooter-java.lang.Object-"><code>RestResponse.setHtmlFooter(Object)</code></a> methods.</div> +<dl> +<dt>Default:</dt> +<dd>""</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="css--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>css</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/HtmlDoc.html#line.292">css</a></pre> +<div class="block">Sets the HTML CSS style section contents. + <p> + The format of this value is CSS. + <p> + <h5 class='section'>Example:</h5> + <p class='bcode'> + <ja>@RestResource</ja>( + htmldoc=<ja>@HtmlDoc</ja>( + css=<js>".red{color:red;}\n.blue{color:blue}"</js> + ) + ) + </p> + <p> + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <p> + A value of <js>"NONE"</js> can be used to force no value. + <p> + The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlCss-java.lang.String-"><code>RestConfig.setHtmlCss(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlCss-java.lang.Object-"><code>RestResponse.setHtmlCss(Object)</code></a> methods.</div> +<dl> +<dt>Default:</dt> +<dd>""</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="cssUrl--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>cssUrl</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/HtmlDoc.html#line.317">cssUrl</a></pre> +<div class="block">Sets the CSS URL in the HTML CSS style section. + <p> + The format of this value is a URL. + <p> + Specifies the URL to the stylesheet to add as a link in the style tag in the header. + <p> + The format of this value is CSS. + <p> + <h5 class='section'>Example:</h5> + <p class='bcode'> + <ja>@RestResource</ja>( + htmldoc=<ja>@HtmlDoc</ja>( + cssUrl=<js>"http://someOtherHost/stealTheir.css";</js> + ) + ) + </p> + <p> + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>) and can use URL protocols defined + by <a href="../../../../../org/apache/juneau/UriResolver.html" title="class in org.apache.juneau"><code>UriResolver</code></a>. + <p> + The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlCssUrl-java.lang.String-"><code>RestConfig.setHtmlCssUrl(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlCssUrl-java.lang.Object-"><code>RestResponse.setHtmlCssUrl(Object)</code></a> methods.</div> +<dl> +<dt>Default:</dt> +<dd>"servlet:/style.css"</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="nowrap--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>nowrap</h4> +<pre>public abstract boolean <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.322">nowrap</a></pre> +<div class="block">Shorthand method for forcing the rendered HTML content to be no-wrap.</div> +<dl> +<dt>Default:</dt> +<dd>false</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="noResultsMessage--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>noResultsMessage</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/HtmlDoc.html#line.327">noResultsMessage</a></pre> +<div class="block">Specifies the text to display when serializing an empty array or collection.</div> +<dl> +<dt>Default:</dt> +<dd>"no results"</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="template--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>template</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/html/HtmlDocTemplate.html" title="interface in org.apache.juneau.html">HtmlDocTemplate</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.338">template</a></pre> +<div class="block">Specifies the template class to use for rendering the HTML page. + <p> + By default, uses <a href="../../../../../org/apache/juneau/html/HtmlDocTemplateBasic.html" title="class in org.apache.juneau.html"><code>HtmlDocTemplateBasic</code></a> to render the contents, although you can provide + your own custom renderer or subclasses from the basic class to have full control over how the page is + rendered. + <p> + The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlTemplate-java.lang.Class-"><code>RestConfig.setHtmlTemplate(Class)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlTemplate-java.lang.Class-"><code>RestResponse.setHtmlTemplate(Class)</code></a> methods.</div> +<dl> +<dt>Default:</dt> +<dd>org.apache.juneau.html.HtmlDocTemplate.class</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/Header.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/Inherit.html" title="enum 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/HtmlDoc.html" target="_top">Frames</a></li> +<li><a href="HtmlDoc.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/Inherit.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/Inherit.html b/content/site/apidocs/org/apache/juneau/rest/annotation/Inherit.html index c007ad4..8684aef 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/Inherit.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/Inherit.html @@ -48,7 +48,7 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/juneau/rest/annotation/Header.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/HtmlDoc.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/Messages.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> @@ -332,7 +332,7 @@ not permitted.)</div> </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/juneau/rest/annotation/Header.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/HtmlDoc.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/Messages.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/Method.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/Method.html b/content/site/apidocs/org/apache/juneau/rest/annotation/Method.html index 67bac79..66950a8 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/Method.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/Method.html @@ -43,7 +43,7 @@ <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/juneau/rest/annotation/Messages.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/Parameter.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../../org/apache/juneau/rest/annotation/MethodSwagger.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/Method.html" target="_top">Frames</a></li> @@ -145,7 +145,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/juneau/rest/annotation/Messages.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/Parameter.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../../org/apache/juneau/rest/annotation/MethodSwagger.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/Method.html" target="_top">Frames</a></li> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/017373e3/content/site/apidocs/org/apache/juneau/rest/annotation/MethodSwagger.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/MethodSwagger.html b/content/site/apidocs/org/apache/juneau/rest/annotation/MethodSwagger.html new file mode 100644 index 0000000..8fa87e2 --- /dev/null +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/MethodSwagger.html @@ -0,0 +1,442 @@ +<!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>MethodSwagger (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="MethodSwagger (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/Method.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/Parameter.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/MethodSwagger.html" target="_top">Frames</a></li> +<li><a href="MethodSwagger.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 MethodSwagger" class="title">Annotation Type MethodSwagger</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/MethodSwagger.html#line.18">MethodSwagger</a></pre> +<div class="block">Extended annotation for <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#swagger--"><code>RestMethod.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>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/MethodSwagger.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/MethodSwagger.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="../../../../../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/MethodSwagger.html#parameters--">parameters</a></span></code> +<div class="block">Optional parameter descriptions.</div> +</td> +</tr> +<tr class="rowColor"> +<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/MethodSwagger.html#responses--">responses</a></span></code> +<div class="block">Optional output description.</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/MethodSwagger.html#tags--">tags</a></span></code> +<div class="block">Optional tagging information for the exposed API.</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="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/MethodSwagger.html#line.49">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>( + swagger=<ja>@MethodSwagger</ja>( + <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/MethodSwagger.html#line.75">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>( + swagger=<ja>@MethodSwagger</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/MethodSwagger.html#line.98">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>( + swagger=<ja>@MethodSwagger</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/MethodSwagger.html#line.137">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>, + swagger=<ja>@MethodSwagger</ja>( + 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="blockListLast"> +<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/MethodSwagger.html#line.175">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>, + swagger=<ja>@MethodSwagger</ja>( + 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> +</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/Method.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/Parameter.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/MethodSwagger.html" target="_top">Frames</a></li> +<li><a href="MethodSwagger.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/Parameter.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/Parameter.html b/content/site/apidocs/org/apache/juneau/rest/annotation/Parameter.html index 12fad76..9a8f363 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/Parameter.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/Parameter.html @@ -42,7 +42,7 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/juneau/rest/annotation/Method.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/MethodSwagger.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/Path.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> @@ -96,17 +96,19 @@ <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/Parameter.html#line.41">Parameter</a></pre> -<div class="block">Annotation used in conjunction with <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#parameters--"><code>RestMethod.parameters()</code></a> to identify content and header descriptions +public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annotation/Parameter.html#line.43">Parameter</a></pre> +<div class="block">Annotation used in conjunction with <a href="../../../../../org/apache/juneau/rest/annotation/MethodSwagger.html#parameters--"><code>MethodSwagger.parameters()</code></a> to identify content and header descriptions on specific method requests. <h5 class='section'>Example:</h5> <p class='bcode'> <ja>@RestMethod</ja>( name=<js>"*"</js>, - parameters={ - <ja>@Parameter</ja>(in=<js>"header"</js>, name=<js>"Range"</js>, description=<js>"$L{ContentRange.description}"</js>) - } + swagger=@MethodSwagger( + parameters={ + <ja>@Parameter</ja>(in=<js>"header"</js>, name=<js>"Range"</js>, description=<js>"$L{ContentRange.description}"</js>) + } + ) ) <jk>public void</jk> doAnything(RestRequest req, RestResponse res, <ja>@Method</ja> String method) { ... @@ -217,7 +219,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>in</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/Parameter.html#line.55">in</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/Parameter.html#line.57">in</a></pre> <div class="block">The location of the parameter. <p> Possible values are: @@ -243,7 +245,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/Parameter.html#line.66">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/Parameter.html#line.68">name</a></pre> <div class="block">The name of the parameter (e.g. <js>"Content-Range"</js>). <p> Parameter names are case sensitive. @@ -266,7 +268,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/Parameter.html#line.78">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/Parameter.html#line.80">description</a></pre> <div class="block">Parameter description (e.g. <js>"Indicates the range returned when Range header is present in the request"</js>). <p> A brief description of the parameter. @@ -290,7 +292,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>required</h4> -<pre>public abstract boolean <a href="../../../../../src-html/org/apache/juneau/rest/annotation/Parameter.html#line.86">required</a></pre> +<pre>public abstract boolean <a href="../../../../../src-html/org/apache/juneau/rest/annotation/Parameter.html#line.88">required</a></pre> <div class="block">Determines whether this parameter is mandatory. <p> If the parameter is <code>in</code> <js>"path"</js>, this property is required and its value MUST be <jk>true</jk>. @@ -310,7 +312,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/Parameter.html#line.108">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/Parameter.html#line.110">schema</a></pre> <div class="block">The schema defining the type used for the body parameter. <p> Only applicable for <code>in</code> of type <js>"body"</js>. @@ -344,7 +346,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>type</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/Parameter.html#line.116">type</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/Parameter.html#line.118">type</a></pre> <div class="block">The type of the parameter. <p> The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>, <js>"array"</js> or <js>"file"</js>. @@ -364,7 +366,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>format</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/Parameter.html#line.123">format</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/Parameter.html#line.125">format</a></pre> <div class="block">The extending format for the previously mentioned <code>type</code>. <p> See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat";>Data Type Formats</a> for further details.</div> @@ -383,7 +385,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>allowEmptyValue</h4> -<pre>public abstract boolean <a href="../../../../../src-html/org/apache/juneau/rest/annotation/Parameter.html#line.131">allowEmptyValue</a></pre> +<pre>public abstract boolean <a href="../../../../../src-html/org/apache/juneau/rest/annotation/Parameter.html#line.133">allowEmptyValue</a></pre> <div class="block">Sets the ability to pass empty-valued parameters. <p> This is valid only for either <code>query</code> or <code>formData</code> parameters and allows you to send a parameter with a name only or an empty value. @@ -403,7 +405,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>items</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/Parameter.html#line.154">items</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/Parameter.html#line.156">items</a></pre> <div class="block">Required if <code>type</code> is <js>"array"</js>. <p> Describes the type of items in the array. @@ -438,7 +440,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>collectionFormat</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/Parameter.html#line.170">collectionFormat</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/Parameter.html#line.172">collectionFormat</a></pre> <div class="block">Determines the format of the array if type array is used. <p> Possible values are: @@ -466,7 +468,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockListLast"> <li class="blockList"> <h4>_default</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/Parameter.html#line.180">_default</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/Parameter.html#line.182">_default</a></pre> <div class="block">Declares the value of the parameter that the server will use if none is provided. <p> For example a "count" to control the number of results per page might default to 100 if not supplied by the client in the request. @@ -506,7 +508,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/Method.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/MethodSwagger.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/Path.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/Query.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/Query.html b/content/site/apidocs/org/apache/juneau/rest/annotation/Query.html index 4c4c746..6d09b3b 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/Query.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/Query.html @@ -43,7 +43,7 @@ <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/juneau/rest/annotation/Property.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> +<li><a href="../../../../../org/apache/juneau/rest/annotation/ResourceSwagger.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/Query.html" target="_top">Frames</a></li> @@ -307,7 +307,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/juneau/rest/annotation/Property.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> +<li><a href="../../../../../org/apache/juneau/rest/annotation/ResourceSwagger.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/Query.html" target="_top">Frames</a></li>
