http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/MethodSwagger.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/MethodSwagger.html b/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/MethodSwagger.html index 26a6e23..4fe5c06 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/MethodSwagger.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/MethodSwagger.html @@ -20,199 +20,206 @@ <span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a> <span class="sourceLineNo">013</span>package org.apache.juneau.rest.annotation;<a name="line.13"></a> <span class="sourceLineNo">014</span><a name="line.14"></a> -<span class="sourceLineNo">015</span>/**<a name="line.15"></a> -<span class="sourceLineNo">016</span> * Extended annotation for {@link RestMethod#swagger() RestMethod.swagger()}.<a name="line.16"></a> -<span class="sourceLineNo">017</span> */<a name="line.17"></a> -<span class="sourceLineNo">018</span>public @interface MethodSwagger {<a name="line.18"></a> -<span class="sourceLineNo">019</span><a name="line.19"></a> -<span class="sourceLineNo">020</span> /**<a name="line.20"></a> -<span class="sourceLineNo">021</span> * Optional external documentation information for the exposed API.<a name="line.21"></a> -<span class="sourceLineNo">022</span> *<a name="line.22"></a> -<span class="sourceLineNo">023</span> * <p><a name="line.23"></a> -<span class="sourceLineNo">024</span> * Used to populate the Swagger external documentation field.<a name="line.24"></a> -<span class="sourceLineNo">025</span> *<a name="line.25"></a> -<span class="sourceLineNo">026</span> * <p><a name="line.26"></a> -<span class="sourceLineNo">027</span> * A simplified JSON string with the following fields:<a name="line.27"></a> -<span class="sourceLineNo">028</span> * <p class='bcode'><a name="line.28"></a> -<span class="sourceLineNo">029</span> * {<a name="line.29"></a> -<span class="sourceLineNo">030</span> * description: string,<a name="line.30"></a> -<span class="sourceLineNo">031</span> * url: string<a name="line.31"></a> -<span class="sourceLineNo">032</span> * }<a name="line.32"></a> -<span class="sourceLineNo">033</span> * </p><a name="line.33"></a> -<span class="sourceLineNo">034</span> *<a name="line.34"></a> -<span class="sourceLineNo">035</span> * <p><a name="line.35"></a> -<span class="sourceLineNo">036</span> * The default value pulls the description from the <code>(className.?)[javaMethodName].externalDocs</code> entry in<a name="line.36"></a> -<span class="sourceLineNo">037</span> * the servlet resource bundle.<a name="line.37"></a> -<span class="sourceLineNo">038</span> * (e.g. <js>"MyClass.myMethod.externalDocs = {url:'http://juneau.apache.org'}"</js> or<a name="line.38"></a> -<span class="sourceLineNo">039</span> * <js>"myMethod.externalDocs = {url:'http://juneau.apache.org'}"</js>).<a name="line.39"></a> -<span class="sourceLineNo">040</span> *<a name="line.40"></a> -<span class="sourceLineNo">041</span> * <h5 class='section'>Example:</h5><a name="line.41"></a> -<span class="sourceLineNo">042</span> * <p class='bcode'><a name="line.42"></a> -<span class="sourceLineNo">043</span> * <ja>@RestMethod</ja>(<a name="line.43"></a> -<span class="sourceLineNo">044</span> * swagger=<ja>@MethodSwagger</ja>(<a name="line.44"></a> -<span class="sourceLineNo">045</span> * <js>"{url:'http://juneau.apache.org'}"</js><a name="line.45"></a> -<span class="sourceLineNo">046</span> * )<a name="line.46"></a> -<span class="sourceLineNo">047</span> * )<a name="line.47"></a> -<span class="sourceLineNo">048</span> * </p><a name="line.48"></a> -<span class="sourceLineNo">049</span> *<a name="line.49"></a> -<span class="sourceLineNo">050</span> * <p><a name="line.50"></a> -<span class="sourceLineNo">051</span> * This field can contain variables (e.g. "$L{my.localized.variable}").<a name="line.51"></a> -<span class="sourceLineNo">052</span> *<a name="line.52"></a> -<span class="sourceLineNo">053</span> * <p><a name="line.53"></a> -<span class="sourceLineNo">054</span> * Corresponds to the swagger field <code>/paths/{path}/{method}/externalDocs</code>.<a name="line.54"></a> -<span class="sourceLineNo">055</span> */<a name="line.55"></a> -<span class="sourceLineNo">056</span> String externalDocs() default "";<a name="line.56"></a> -<span class="sourceLineNo">057</span><a name="line.57"></a> -<span class="sourceLineNo">058</span> /**<a name="line.58"></a> -<span class="sourceLineNo">059</span> * Optional tagging information for the exposed API.<a name="line.59"></a> -<span class="sourceLineNo">060</span> *<a name="line.60"></a> -<span class="sourceLineNo">061</span> * <p><a name="line.61"></a> -<span class="sourceLineNo">062</span> * Used to populate the Swagger tags field.<a name="line.62"></a> +<span class="sourceLineNo">015</span>import org.apache.juneau.rest.*;<a name="line.15"></a> +<span class="sourceLineNo">016</span><a name="line.16"></a> +<span class="sourceLineNo">017</span>/**<a name="line.17"></a> +<span class="sourceLineNo">018</span> * Extended annotation for {@link RestMethod#swagger() RestMethod.swagger()}.<a name="line.18"></a> +<span class="sourceLineNo">019</span> */<a name="line.19"></a> +<span class="sourceLineNo">020</span>public @interface MethodSwagger {<a name="line.20"></a> +<span class="sourceLineNo">021</span><a name="line.21"></a> +<span class="sourceLineNo">022</span> /**<a name="line.22"></a> +<span class="sourceLineNo">023</span> * Optional external documentation information for the exposed API.<a name="line.23"></a> +<span class="sourceLineNo">024</span> *<a name="line.24"></a> +<span class="sourceLineNo">025</span> * <p><a name="line.25"></a> +<span class="sourceLineNo">026</span> * Used to populate the Swagger external documentation field.<a name="line.26"></a> +<span class="sourceLineNo">027</span> *<a name="line.27"></a> +<span class="sourceLineNo">028</span> * <p><a name="line.28"></a> +<span class="sourceLineNo">029</span> * A simplified JSON string with the following fields:<a name="line.29"></a> +<span class="sourceLineNo">030</span> * <p class='bcode'><a name="line.30"></a> +<span class="sourceLineNo">031</span> * {<a name="line.31"></a> +<span class="sourceLineNo">032</span> * description: string,<a name="line.32"></a> +<span class="sourceLineNo">033</span> * url: string<a name="line.33"></a> +<span class="sourceLineNo">034</span> * }<a name="line.34"></a> +<span class="sourceLineNo">035</span> * </p><a name="line.35"></a> +<span class="sourceLineNo">036</span> *<a name="line.36"></a> +<span class="sourceLineNo">037</span> * <p><a name="line.37"></a> +<span class="sourceLineNo">038</span> * The default value pulls the description from the <code>(className.?)[javaMethodName].externalDocs</code> entry in<a name="line.38"></a> +<span class="sourceLineNo">039</span> * the servlet resource bundle.<a name="line.39"></a> +<span class="sourceLineNo">040</span> * (e.g. <js>"MyClass.myMethod.externalDocs = {url:'http://juneau.apache.org'}"</js> or<a name="line.40"></a> +<span class="sourceLineNo">041</span> * <js>"myMethod.externalDocs = {url:'http://juneau.apache.org'}"</js>).<a name="line.41"></a> +<span class="sourceLineNo">042</span> *<a name="line.42"></a> +<span class="sourceLineNo">043</span> * <h5 class='section'>Example:</h5><a name="line.43"></a> +<span class="sourceLineNo">044</span> * <p class='bcode'><a name="line.44"></a> +<span class="sourceLineNo">045</span> * <ja>@RestMethod</ja>(<a name="line.45"></a> +<span class="sourceLineNo">046</span> * swagger=<ja>@MethodSwagger</ja>(<a name="line.46"></a> +<span class="sourceLineNo">047</span> * <js>"{url:'http://juneau.apache.org'}"</js><a name="line.47"></a> +<span class="sourceLineNo">048</span> * )<a name="line.48"></a> +<span class="sourceLineNo">049</span> * )<a name="line.49"></a> +<span class="sourceLineNo">050</span> * </p><a name="line.50"></a> +<span class="sourceLineNo">051</span> *<a name="line.51"></a> +<span class="sourceLineNo">052</span> * <p><a name="line.52"></a> +<span class="sourceLineNo">053</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.53"></a> +<span class="sourceLineNo">054</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.54"></a> +<span class="sourceLineNo">055</span> *<a name="line.55"></a> +<span class="sourceLineNo">056</span> * <p><a name="line.56"></a> +<span class="sourceLineNo">057</span> * Corresponds to the swagger field <code>/paths/{path}/{method}/externalDocs</code>.<a name="line.57"></a> +<span class="sourceLineNo">058</span> */<a name="line.58"></a> +<span class="sourceLineNo">059</span> String externalDocs() default "";<a name="line.59"></a> +<span class="sourceLineNo">060</span><a name="line.60"></a> +<span class="sourceLineNo">061</span> /**<a name="line.61"></a> +<span class="sourceLineNo">062</span> * Optional tagging information for the exposed API.<a name="line.62"></a> <span class="sourceLineNo">063</span> *<a name="line.63"></a> <span class="sourceLineNo">064</span> * <p><a name="line.64"></a> -<span class="sourceLineNo">065</span> * A comma-delimited list of tags for API documentation control.<a name="line.65"></a> -<span class="sourceLineNo">066</span> * Tags can be used for logical grouping of operations by resources or any other qualifier.<a name="line.66"></a> -<span class="sourceLineNo">067</span> *<a name="line.67"></a> -<span class="sourceLineNo">068</span> * <p><a name="line.68"></a> -<span class="sourceLineNo">069</span> * The default value pulls the description from the <code>(className.?)[javaMethodName].tags</code> entry in the<a name="line.69"></a> -<span class="sourceLineNo">070</span> * servlet resource bundle.<a name="line.70"></a> -<span class="sourceLineNo">071</span> * (e.g. <js>"MyClass.myMethod.tags = foo,bar"</js> or <js>"myMethod.tags = foo,bar"</js>).<a name="line.71"></a> -<span class="sourceLineNo">072</span> *<a name="line.72"></a> -<span class="sourceLineNo">073</span> * <h5 class='section'>Example:</h5><a name="line.73"></a> -<span class="sourceLineNo">074</span> * <p class='bcode'><a name="line.74"></a> -<span class="sourceLineNo">075</span> * <ja>@RestMethod</ja>(<a name="line.75"></a> -<span class="sourceLineNo">076</span> * swagger=<ja>@MethodSwagger</ja>(<a name="line.76"></a> -<span class="sourceLineNo">077</span> * tags=<js>"foo,bar"</js><a name="line.77"></a> -<span class="sourceLineNo">078</span> * )<a name="line.78"></a> -<span class="sourceLineNo">079</span> * )<a name="line.79"></a> -<span class="sourceLineNo">080</span> * </p><a name="line.80"></a> -<span class="sourceLineNo">081</span> *<a name="line.81"></a> -<span class="sourceLineNo">082</span> * <p><a name="line.82"></a> -<span class="sourceLineNo">083</span> * This field can contain variables (e.g. "$L{my.localized.variable}").<a name="line.83"></a> +<span class="sourceLineNo">065</span> * Used to populate the Swagger tags field.<a name="line.65"></a> +<span class="sourceLineNo">066</span> *<a name="line.66"></a> +<span class="sourceLineNo">067</span> * <p><a name="line.67"></a> +<span class="sourceLineNo">068</span> * A comma-delimited list of tags for API documentation control.<a name="line.68"></a> +<span class="sourceLineNo">069</span> * Tags can be used for logical grouping of operations by resources or any other qualifier.<a name="line.69"></a> +<span class="sourceLineNo">070</span> *<a name="line.70"></a> +<span class="sourceLineNo">071</span> * <p><a name="line.71"></a> +<span class="sourceLineNo">072</span> * The default value pulls the description from the <code>(className.?)[javaMethodName].tags</code> entry in the<a name="line.72"></a> +<span class="sourceLineNo">073</span> * servlet resource bundle.<a name="line.73"></a> +<span class="sourceLineNo">074</span> * (e.g. <js>"MyClass.myMethod.tags = foo,bar"</js> or <js>"myMethod.tags = foo,bar"</js>).<a name="line.74"></a> +<span class="sourceLineNo">075</span> *<a name="line.75"></a> +<span class="sourceLineNo">076</span> * <h5 class='section'>Example:</h5><a name="line.76"></a> +<span class="sourceLineNo">077</span> * <p class='bcode'><a name="line.77"></a> +<span class="sourceLineNo">078</span> * <ja>@RestMethod</ja>(<a name="line.78"></a> +<span class="sourceLineNo">079</span> * swagger=<ja>@MethodSwagger</ja>(<a name="line.79"></a> +<span class="sourceLineNo">080</span> * tags=<js>"foo,bar"</js><a name="line.80"></a> +<span class="sourceLineNo">081</span> * )<a name="line.81"></a> +<span class="sourceLineNo">082</span> * )<a name="line.82"></a> +<span class="sourceLineNo">083</span> * </p><a name="line.83"></a> <span class="sourceLineNo">084</span> *<a name="line.84"></a> <span class="sourceLineNo">085</span> * <p><a name="line.85"></a> -<span class="sourceLineNo">086</span> * Corresponds to the swagger field <code>/paths/{path}/{method}/tags</code>.<a name="line.86"></a> -<span class="sourceLineNo">087</span> */<a name="line.87"></a> -<span class="sourceLineNo">088</span> String tags() default "";<a name="line.88"></a> -<span class="sourceLineNo">089</span><a name="line.89"></a> -<span class="sourceLineNo">090</span> /**<a name="line.90"></a> -<span class="sourceLineNo">091</span> * Optional deprecated flag for the exposed API.<a name="line.91"></a> -<span class="sourceLineNo">092</span> *<a name="line.92"></a> -<span class="sourceLineNo">093</span> * <p><a name="line.93"></a> -<span class="sourceLineNo">094</span> * Used to populate the Swagger deprecated field.<a name="line.94"></a> -<span class="sourceLineNo">095</span> *<a name="line.95"></a> -<span class="sourceLineNo">096</span> * <p><a name="line.96"></a> -<span class="sourceLineNo">097</span> * The default value pulls the description from the <code>(className.?)[javaMethodName].deprecated</code> entry in<a name="line.97"></a> -<span class="sourceLineNo">098</span> * the servlet resource bundle.<a name="line.98"></a> -<span class="sourceLineNo">099</span> * (e.g. <js>"MyClass.myMethod.deprecated = true"</js> or <js>"myMethod.deprecated = foo,bar"</js>).<a name="line.99"></a> -<span class="sourceLineNo">100</span> *<a name="line.100"></a> -<span class="sourceLineNo">101</span> * <h5 class='section'>Example:</h5><a name="line.101"></a> -<span class="sourceLineNo">102</span> * <p class='bcode'><a name="line.102"></a> -<span class="sourceLineNo">103</span> * <ja>@RestMethod</ja>(<a name="line.103"></a> -<span class="sourceLineNo">104</span> * swagger=<ja>@MethodSwagger</ja>(<a name="line.104"></a> -<span class="sourceLineNo">105</span> * deprecated=<jk>true</jk><a name="line.105"></a> -<span class="sourceLineNo">106</span> * )<a name="line.106"></a> -<span class="sourceLineNo">107</span> * )<a name="line.107"></a> -<span class="sourceLineNo">108</span> * </p><a name="line.108"></a> -<span class="sourceLineNo">109</span> *<a name="line.109"></a> -<span class="sourceLineNo">110</span> * <p><a name="line.110"></a> -<span class="sourceLineNo">111</span> * This field can contain variables (e.g. "$L{my.localized.variable}").<a name="line.111"></a> -<span class="sourceLineNo">112</span> *<a name="line.112"></a> -<span class="sourceLineNo">113</span> * <p><a name="line.113"></a> -<span class="sourceLineNo">114</span> * Corresponds to the swagger field <code>/paths/{path}/{method}/deprecated</code>.<a name="line.114"></a> -<span class="sourceLineNo">115</span> */<a name="line.115"></a> -<span class="sourceLineNo">116</span> boolean deprecated() default false;<a name="line.116"></a> -<span class="sourceLineNo">117</span><a name="line.117"></a> -<span class="sourceLineNo">118</span> /**<a name="line.118"></a> -<span class="sourceLineNo">119</span> * Optional parameter descriptions.<a name="line.119"></a> -<span class="sourceLineNo">120</span> *<a name="line.120"></a> -<span class="sourceLineNo">121</span> * <p><a name="line.121"></a> -<span class="sourceLineNo">122</span> * This annotation is provided for documentation purposes and is used to populate the method <js>"parameters"</js><a name="line.122"></a> -<span class="sourceLineNo">123</span> * column on the Swagger page.<a name="line.123"></a> -<span class="sourceLineNo">124</span> *<a name="line.124"></a> -<span class="sourceLineNo">125</span> * <h5 class='section'>Example:</h5><a name="line.125"></a> -<span class="sourceLineNo">126</span> * <p class='bcode'><a name="line.126"></a> -<span class="sourceLineNo">127</span> * <ja>@RestMethod</ja>(<a name="line.127"></a> -<span class="sourceLineNo">128</span> * name=<js>"POST"</js>, path=<js>"/{a}"</js>,<a name="line.128"></a> -<span class="sourceLineNo">129</span> * description=<js>"This is my method."</js>,<a name="line.129"></a> -<span class="sourceLineNo">130</span> * swagger=<ja>@MethodSwagger</ja>(<a name="line.130"></a> -<span class="sourceLineNo">131</span> * parameters={<a name="line.131"></a> -<span class="sourceLineNo">132</span> * <ja>@Parameter</ja>(in=<js>"path"</js>, name=<js>"a"</js>, description=<js>"The 'a' attribute"</js>),<a name="line.132"></a> -<span class="sourceLineNo">133</span> * <ja>@Parameter</ja>(in=<js>"query"</js>, name=<js>"b"</js>, description=<js>"The 'b' parameter"</js>, required=<jk>true</jk>),<a name="line.133"></a> -<span class="sourceLineNo">134</span> * <ja>@Parameter</ja>(in=<js>"body"</js>, description=<js>"The HTTP content"</js>),<a name="line.134"></a> -<span class="sourceLineNo">135</span> * <ja>@Parameter</ja>(in=<js>"header"</js>, name=<js>"D"</js>, description=<js>"The 'D' header"</js>),<a name="line.135"></a> -<span class="sourceLineNo">136</span> * }<a name="line.136"></a> -<span class="sourceLineNo">137</span> * )<a name="line.137"></a> -<span class="sourceLineNo">138</span> * )<a name="line.138"></a> -<span class="sourceLineNo">139</span> * </p><a name="line.139"></a> -<span class="sourceLineNo">140</span> *<a name="line.140"></a> -<span class="sourceLineNo">141</span> * <p><a name="line.141"></a> -<span class="sourceLineNo">142</span> * This is functionally equivalent to specifying the following keys in the resource bundle for the class, except in<a name="line.142"></a> -<span class="sourceLineNo">143</span> * this case the strings are internationalized.<a name="line.143"></a> -<span class="sourceLineNo">144</span> * <p class='bcode'><a name="line.144"></a> -<span class="sourceLineNo">145</span> * <jk>MyClass.myMethod.description</jk> = <js>This is my method.</js><a name="line.145"></a> -<span class="sourceLineNo">146</span> * <jk>MyClass.myMethod.req.path.a.description</jk> = <js>The 'a' attribute</js><a name="line.146"></a> -<span class="sourceLineNo">147</span> * <jk>MyClass.myMethod.req.query.b.description</jk> = <js>The 'b' parameter</js><a name="line.147"></a> -<span class="sourceLineNo">148</span> * <jk>MyClass.myMethod.req.body.description</jk> = <js>The HTTP content</js><a name="line.148"></a> -<span class="sourceLineNo">149</span> * <jk>MyClass.myMethod.req.header.d.description</jk> = <js>The 'D' header</js><a name="line.149"></a> -<span class="sourceLineNo">150</span> * </p><a name="line.150"></a> -<span class="sourceLineNo">151</span> *<a name="line.151"></a> -<span class="sourceLineNo">152</span> * <p><a name="line.152"></a> -<span class="sourceLineNo">153</span> * As a general rule, use annotations when you don't care about internationalization (i.e. you only want to support<a name="line.153"></a> -<span class="sourceLineNo">154</span> * English), and use resource bundles if you need to support localization.<a name="line.154"></a> -<span class="sourceLineNo">155</span> *<a name="line.155"></a> -<span class="sourceLineNo">156</span> * <p><a name="line.156"></a> -<span class="sourceLineNo">157</span> * These annotations can contain variables (e.g. "$L{my.localized.variable}").<a name="line.157"></a> -<span class="sourceLineNo">158</span> *<a name="line.158"></a> -<span class="sourceLineNo">159</span> * <p><a name="line.159"></a> -<span class="sourceLineNo">160</span> * Corresponds to the swagger field <code>/paths/{path}/{method}/parameters</code>.<a name="line.160"></a> -<span class="sourceLineNo">161</span> */<a name="line.161"></a> -<span class="sourceLineNo">162</span> Parameter[] parameters() default {};<a name="line.162"></a> -<span class="sourceLineNo">163</span><a name="line.163"></a> -<span class="sourceLineNo">164</span> /**<a name="line.164"></a> -<span class="sourceLineNo">165</span> * Optional output description.<a name="line.165"></a> -<span class="sourceLineNo">166</span> *<a name="line.166"></a> -<span class="sourceLineNo">167</span> * <p><a name="line.167"></a> -<span class="sourceLineNo">168</span> * This annotation is provided for documentation purposes and is used to populate the method <js>"responses"</js><a name="line.168"></a> -<span class="sourceLineNo">169</span> * column on the Swagger page.<a name="line.169"></a> -<span class="sourceLineNo">170</span> *<a name="line.170"></a> -<span class="sourceLineNo">171</span> * <h5 class='section'>Example:</h5><a name="line.171"></a> -<span class="sourceLineNo">172</span> * <p class='bcode'><a name="line.172"></a> -<span class="sourceLineNo">173</span> * <ja>@RestMethod</ja>(<a name="line.173"></a> -<span class="sourceLineNo">174</span> * name=<js>"GET"</js>, path=<js>"/"</js>,<a name="line.174"></a> -<span class="sourceLineNo">175</span> * swagger=<ja>@MethodSwagger</ja>(<a name="line.175"></a> -<span class="sourceLineNo">176</span> * responses={<a name="line.176"></a> -<span class="sourceLineNo">177</span> * <ja>@Response</ja>(200),<a name="line.177"></a> -<span class="sourceLineNo">178</span> * <ja>@Response</ja>(<a name="line.178"></a> -<span class="sourceLineNo">179</span> * value=302,<a name="line.179"></a> -<span class="sourceLineNo">180</span> * description=<js>"Thing wasn't found here"</js>,<a name="line.180"></a> -<span class="sourceLineNo">181</span> * headers={<a name="line.181"></a> -<span class="sourceLineNo">182</span> * <ja>@Parameter</ja>(name=<js>"Location"</js>, description=<js>"The place to find the thing"</js>)<a name="line.182"></a> -<span class="sourceLineNo">183</span> * }<a name="line.183"></a> -<span class="sourceLineNo">184</span> * )<a name="line.184"></a> -<span class="sourceLineNo">185</span> * }<a name="line.185"></a> -<span class="sourceLineNo">186</span> * )<a name="line.186"></a> -<span class="sourceLineNo">187</span> * )<a name="line.187"></a> -<span class="sourceLineNo">188</span> * </p><a name="line.188"></a> -<span class="sourceLineNo">189</span> *<a name="line.189"></a> -<span class="sourceLineNo">190</span> * <p><a name="line.190"></a> -<span class="sourceLineNo">191</span> * This is functionally equivalent to specifying the following keys in the resource bundle for the class, except in<a name="line.191"></a> -<span class="sourceLineNo">192</span> * this case the strings are internationalized.<a name="line.192"></a> -<span class="sourceLineNo">193</span> * <p class='bcode'><a name="line.193"></a> -<span class="sourceLineNo">194</span> * <jk>MyClass.myMethod.res.200.description</jk> = <js>OK</js><a name="line.194"></a> -<span class="sourceLineNo">195</span> * <jk>MyClass.myMethod.res.302.description</jk> = <js>Thing wasn't found here</js><a name="line.195"></a> -<span class="sourceLineNo">196</span> * <jk>MyClass.myMethod.res.302.header.Location.description</jk> = <js>The place to find the thing</js><a name="line.196"></a> -<span class="sourceLineNo">197</span> * </p><a name="line.197"></a> -<span class="sourceLineNo">198</span> *<a name="line.198"></a> -<span class="sourceLineNo">199</span> * <p><a name="line.199"></a> -<span class="sourceLineNo">200</span> * As a general rule, use annotations when you don't care about internationalization (i.e. you only want to support<a name="line.200"></a> -<span class="sourceLineNo">201</span> * English), and use resource bundles if you need to support localization.<a name="line.201"></a> -<span class="sourceLineNo">202</span> *<a name="line.202"></a> -<span class="sourceLineNo">203</span> * <p><a name="line.203"></a> -<span class="sourceLineNo">204</span> * These annotations can contain variables (e.g. "$L{my.localized.variable}").<a name="line.204"></a> -<span class="sourceLineNo">205</span> */<a name="line.205"></a> -<span class="sourceLineNo">206</span> Response[] responses() default {};<a name="line.206"></a> -<span class="sourceLineNo">207</span>}<a name="line.207"></a> +<span class="sourceLineNo">086</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.86"></a> +<span class="sourceLineNo">087</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.87"></a> +<span class="sourceLineNo">088</span> *<a name="line.88"></a> +<span class="sourceLineNo">089</span> * <p><a name="line.89"></a> +<span class="sourceLineNo">090</span> * Corresponds to the swagger field <code>/paths/{path}/{method}/tags</code>.<a name="line.90"></a> +<span class="sourceLineNo">091</span> */<a name="line.91"></a> +<span class="sourceLineNo">092</span> String tags() default "";<a name="line.92"></a> +<span class="sourceLineNo">093</span><a name="line.93"></a> +<span class="sourceLineNo">094</span> /**<a name="line.94"></a> +<span class="sourceLineNo">095</span> * Optional deprecated flag for the exposed API.<a name="line.95"></a> +<span class="sourceLineNo">096</span> *<a name="line.96"></a> +<span class="sourceLineNo">097</span> * <p><a name="line.97"></a> +<span class="sourceLineNo">098</span> * Used to populate the Swagger deprecated field.<a name="line.98"></a> +<span class="sourceLineNo">099</span> *<a name="line.99"></a> +<span class="sourceLineNo">100</span> * <p><a name="line.100"></a> +<span class="sourceLineNo">101</span> * The default value pulls the description from the <code>(className.?)[javaMethodName].deprecated</code> entry in<a name="line.101"></a> +<span class="sourceLineNo">102</span> * the servlet resource bundle.<a name="line.102"></a> +<span class="sourceLineNo">103</span> * (e.g. <js>"MyClass.myMethod.deprecated = true"</js> or <js>"myMethod.deprecated = foo,bar"</js>).<a name="line.103"></a> +<span class="sourceLineNo">104</span> *<a name="line.104"></a> +<span class="sourceLineNo">105</span> * <h5 class='section'>Example:</h5><a name="line.105"></a> +<span class="sourceLineNo">106</span> * <p class='bcode'><a name="line.106"></a> +<span class="sourceLineNo">107</span> * <ja>@RestMethod</ja>(<a name="line.107"></a> +<span class="sourceLineNo">108</span> * swagger=<ja>@MethodSwagger</ja>(<a name="line.108"></a> +<span class="sourceLineNo">109</span> * deprecated=<jk>true</jk><a name="line.109"></a> +<span class="sourceLineNo">110</span> * )<a name="line.110"></a> +<span class="sourceLineNo">111</span> * )<a name="line.111"></a> +<span class="sourceLineNo">112</span> * </p><a name="line.112"></a> +<span class="sourceLineNo">113</span> *<a name="line.113"></a> +<span class="sourceLineNo">114</span> * <p><a name="line.114"></a> +<span class="sourceLineNo">115</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.115"></a> +<span class="sourceLineNo">116</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.116"></a> +<span class="sourceLineNo">117</span> *<a name="line.117"></a> +<span class="sourceLineNo">118</span> * <p><a name="line.118"></a> +<span class="sourceLineNo">119</span> * Corresponds to the swagger field <code>/paths/{path}/{method}/deprecated</code>.<a name="line.119"></a> +<span class="sourceLineNo">120</span> */<a name="line.120"></a> +<span class="sourceLineNo">121</span> boolean deprecated() default false;<a name="line.121"></a> +<span class="sourceLineNo">122</span><a name="line.122"></a> +<span class="sourceLineNo">123</span> /**<a name="line.123"></a> +<span class="sourceLineNo">124</span> * Optional parameter descriptions.<a name="line.124"></a> +<span class="sourceLineNo">125</span> *<a name="line.125"></a> +<span class="sourceLineNo">126</span> * <p><a name="line.126"></a> +<span class="sourceLineNo">127</span> * This annotation is provided for documentation purposes and is used to populate the method <js>"parameters"</js><a name="line.127"></a> +<span class="sourceLineNo">128</span> * column on the Swagger page.<a name="line.128"></a> +<span class="sourceLineNo">129</span> *<a name="line.129"></a> +<span class="sourceLineNo">130</span> * <h5 class='section'>Example:</h5><a name="line.130"></a> +<span class="sourceLineNo">131</span> * <p class='bcode'><a name="line.131"></a> +<span class="sourceLineNo">132</span> * <ja>@RestMethod</ja>(<a name="line.132"></a> +<span class="sourceLineNo">133</span> * name=<js>"POST"</js>, path=<js>"/{a}"</js>,<a name="line.133"></a> +<span class="sourceLineNo">134</span> * description=<js>"This is my method."</js>,<a name="line.134"></a> +<span class="sourceLineNo">135</span> * swagger=<ja>@MethodSwagger</ja>(<a name="line.135"></a> +<span class="sourceLineNo">136</span> * parameters={<a name="line.136"></a> +<span class="sourceLineNo">137</span> * <ja>@Parameter</ja>(in=<js>"path"</js>, name=<js>"a"</js>, description=<js>"The 'a' attribute"</js>),<a name="line.137"></a> +<span class="sourceLineNo">138</span> * <ja>@Parameter</ja>(in=<js>"query"</js>, name=<js>"b"</js>, description=<js>"The 'b' parameter"</js>, required=<jk>true</jk>),<a name="line.138"></a> +<span class="sourceLineNo">139</span> * <ja>@Parameter</ja>(in=<js>"body"</js>, description=<js>"The HTTP content"</js>),<a name="line.139"></a> +<span class="sourceLineNo">140</span> * <ja>@Parameter</ja>(in=<js>"header"</js>, name=<js>"D"</js>, description=<js>"The 'D' header"</js>),<a name="line.140"></a> +<span class="sourceLineNo">141</span> * }<a name="line.141"></a> +<span class="sourceLineNo">142</span> * )<a name="line.142"></a> +<span class="sourceLineNo">143</span> * )<a name="line.143"></a> +<span class="sourceLineNo">144</span> * </p><a name="line.144"></a> +<span class="sourceLineNo">145</span> *<a name="line.145"></a> +<span class="sourceLineNo">146</span> * <p><a name="line.146"></a> +<span class="sourceLineNo">147</span> * This is functionally equivalent to specifying the following keys in the resource bundle for the class, except in<a name="line.147"></a> +<span class="sourceLineNo">148</span> * this case the strings are internationalized.<a name="line.148"></a> +<span class="sourceLineNo">149</span> * <p class='bcode'><a name="line.149"></a> +<span class="sourceLineNo">150</span> * <jk>MyClass.myMethod.description</jk> = <js>This is my method.</js><a name="line.150"></a> +<span class="sourceLineNo">151</span> * <jk>MyClass.myMethod.req.path.a.description</jk> = <js>The 'a' attribute</js><a name="line.151"></a> +<span class="sourceLineNo">152</span> * <jk>MyClass.myMethod.req.query.b.description</jk> = <js>The 'b' parameter</js><a name="line.152"></a> +<span class="sourceLineNo">153</span> * <jk>MyClass.myMethod.req.body.description</jk> = <js>The HTTP content</js><a name="line.153"></a> +<span class="sourceLineNo">154</span> * <jk>MyClass.myMethod.req.header.d.description</jk> = <js>The 'D' header</js><a name="line.154"></a> +<span class="sourceLineNo">155</span> * </p><a name="line.155"></a> +<span class="sourceLineNo">156</span> *<a name="line.156"></a> +<span class="sourceLineNo">157</span> * <p><a name="line.157"></a> +<span class="sourceLineNo">158</span> * As a general rule, use annotations when you don't care about internationalization (i.e. you only want to support<a name="line.158"></a> +<span class="sourceLineNo">159</span> * English), and use resource bundles if you need to support localization.<a name="line.159"></a> +<span class="sourceLineNo">160</span> *<a name="line.160"></a> +<span class="sourceLineNo">161</span> * <p><a name="line.161"></a> +<span class="sourceLineNo">162</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.162"></a> +<span class="sourceLineNo">163</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.163"></a> +<span class="sourceLineNo">164</span> *<a name="line.164"></a> +<span class="sourceLineNo">165</span> * <p><a name="line.165"></a> +<span class="sourceLineNo">166</span> * Corresponds to the swagger field <code>/paths/{path}/{method}/parameters</code>.<a name="line.166"></a> +<span class="sourceLineNo">167</span> */<a name="line.167"></a> +<span class="sourceLineNo">168</span> Parameter[] parameters() default {};<a name="line.168"></a> +<span class="sourceLineNo">169</span><a name="line.169"></a> +<span class="sourceLineNo">170</span> /**<a name="line.170"></a> +<span class="sourceLineNo">171</span> * Optional output description.<a name="line.171"></a> +<span class="sourceLineNo">172</span> *<a name="line.172"></a> +<span class="sourceLineNo">173</span> * <p><a name="line.173"></a> +<span class="sourceLineNo">174</span> * This annotation is provided for documentation purposes and is used to populate the method <js>"responses"</js><a name="line.174"></a> +<span class="sourceLineNo">175</span> * column on the Swagger page.<a name="line.175"></a> +<span class="sourceLineNo">176</span> *<a name="line.176"></a> +<span class="sourceLineNo">177</span> * <h5 class='section'>Example:</h5><a name="line.177"></a> +<span class="sourceLineNo">178</span> * <p class='bcode'><a name="line.178"></a> +<span class="sourceLineNo">179</span> * <ja>@RestMethod</ja>(<a name="line.179"></a> +<span class="sourceLineNo">180</span> * name=<js>"GET"</js>, path=<js>"/"</js>,<a name="line.180"></a> +<span class="sourceLineNo">181</span> * swagger=<ja>@MethodSwagger</ja>(<a name="line.181"></a> +<span class="sourceLineNo">182</span> * responses={<a name="line.182"></a> +<span class="sourceLineNo">183</span> * <ja>@Response</ja>(200),<a name="line.183"></a> +<span class="sourceLineNo">184</span> * <ja>@Response</ja>(<a name="line.184"></a> +<span class="sourceLineNo">185</span> * value=302,<a name="line.185"></a> +<span class="sourceLineNo">186</span> * description=<js>"Thing wasn't found here"</js>,<a name="line.186"></a> +<span class="sourceLineNo">187</span> * headers={<a name="line.187"></a> +<span class="sourceLineNo">188</span> * <ja>@Parameter</ja>(name=<js>"Location"</js>, description=<js>"The place to find the thing"</js>)<a name="line.188"></a> +<span class="sourceLineNo">189</span> * }<a name="line.189"></a> +<span class="sourceLineNo">190</span> * )<a name="line.190"></a> +<span class="sourceLineNo">191</span> * }<a name="line.191"></a> +<span class="sourceLineNo">192</span> * )<a name="line.192"></a> +<span class="sourceLineNo">193</span> * )<a name="line.193"></a> +<span class="sourceLineNo">194</span> * </p><a name="line.194"></a> +<span class="sourceLineNo">195</span> *<a name="line.195"></a> +<span class="sourceLineNo">196</span> * <p><a name="line.196"></a> +<span class="sourceLineNo">197</span> * This is functionally equivalent to specifying the following keys in the resource bundle for the class, except in<a name="line.197"></a> +<span class="sourceLineNo">198</span> * this case the strings are internationalized.<a name="line.198"></a> +<span class="sourceLineNo">199</span> * <p class='bcode'><a name="line.199"></a> +<span class="sourceLineNo">200</span> * <jk>MyClass.myMethod.res.200.description</jk> = <js>OK</js><a name="line.200"></a> +<span class="sourceLineNo">201</span> * <jk>MyClass.myMethod.res.302.description</jk> = <js>Thing wasn't found here</js><a name="line.201"></a> +<span class="sourceLineNo">202</span> * <jk>MyClass.myMethod.res.302.header.Location.description</jk> = <js>The place to find the thing</js><a name="line.202"></a> +<span class="sourceLineNo">203</span> * </p><a name="line.203"></a> +<span class="sourceLineNo">204</span> *<a name="line.204"></a> +<span class="sourceLineNo">205</span> * <p><a name="line.205"></a> +<span class="sourceLineNo">206</span> * As a general rule, use annotations when you don't care about internationalization (i.e. you only want to support<a name="line.206"></a> +<span class="sourceLineNo">207</span> * English), and use resource bundles if you need to support localization.<a name="line.207"></a> +<span class="sourceLineNo">208</span> *<a name="line.208"></a> +<span class="sourceLineNo">209</span> * <p><a name="line.209"></a> +<span class="sourceLineNo">210</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.210"></a> +<span class="sourceLineNo">211</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.211"></a> +<span class="sourceLineNo">212</span> */<a name="line.212"></a> +<span class="sourceLineNo">213</span> Response[] responses() default {};<a name="line.213"></a> +<span class="sourceLineNo">214</span>}<a name="line.214"></a>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/ResourceSwagger.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/ResourceSwagger.html b/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/ResourceSwagger.html index 177c277..a3e087e 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/ResourceSwagger.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/ResourceSwagger.html @@ -28,210 +28,221 @@ <span class="sourceLineNo">020</span>public @interface ResourceSwagger {<a name="line.20"></a> <span class="sourceLineNo">021</span> /**<a name="line.21"></a> <span class="sourceLineNo">022</span> * Optional servlet terms-of-service for this API.<a name="line.22"></a> -<span class="sourceLineNo">023</span> * <p><a name="line.23"></a> -<span class="sourceLineNo">024</span> * It is used to populate the Swagger terms-of-service field.<a name="line.24"></a> -<span class="sourceLineNo">025</span> * <p><a name="line.25"></a> -<span class="sourceLineNo">026</span> * The default value pulls the description from the <code>termsOfService</code> entry in the servlet resource bundle.<a name="line.26"></a> -<span class="sourceLineNo">027</span> * (e.g. <js>"termsOfService = foo"</js> or <js>"MyServlet.termsOfService = foo"</js>).<a name="line.27"></a> -<span class="sourceLineNo">028</span> * <p><a name="line.28"></a> -<span class="sourceLineNo">029</span> * This field can contain variables (e.g. "$L{my.localized.variable}").<a name="line.29"></a> -<span class="sourceLineNo">030</span> * <p><a name="line.30"></a> -<span class="sourceLineNo">031</span> * Corresponds to the swagger field <code>/info/termsOfService</code>.<a name="line.31"></a> -<span class="sourceLineNo">032</span> * <p><a name="line.32"></a> -<span class="sourceLineNo">033</span> * The programmatic equivalent to this annotation is the {@link RestInfoProvider#getTermsOfService(RestRequest)}<a name="line.33"></a> -<span class="sourceLineNo">034</span> * method.<a name="line.34"></a> -<span class="sourceLineNo">035</span> */<a name="line.35"></a> -<span class="sourceLineNo">036</span> String termsOfService() default "";<a name="line.36"></a> -<span class="sourceLineNo">037</span><a name="line.37"></a> -<span class="sourceLineNo">038</span> /**<a name="line.38"></a> -<span class="sourceLineNo">039</span> * Optional contact information for the exposed API.<a name="line.39"></a> -<span class="sourceLineNo">040</span> *<a name="line.40"></a> -<span class="sourceLineNo">041</span> * <p><a name="line.41"></a> -<span class="sourceLineNo">042</span> * It is used to populate the Swagger contact field and to display on HTML pages.<a name="line.42"></a> -<span class="sourceLineNo">043</span> *<a name="line.43"></a> -<span class="sourceLineNo">044</span> * <p><a name="line.44"></a> -<span class="sourceLineNo">045</span> * A simplified JSON string with the following fields:<a name="line.45"></a> -<span class="sourceLineNo">046</span> * <p class='bcode'><a name="line.46"></a> -<span class="sourceLineNo">047</span> * {<a name="line.47"></a> -<span class="sourceLineNo">048</span> * name: string,<a name="line.48"></a> -<span class="sourceLineNo">049</span> * url: string,<a name="line.49"></a> -<span class="sourceLineNo">050</span> * email: string<a name="line.50"></a> -<span class="sourceLineNo">051</span> * }<a name="line.51"></a> -<span class="sourceLineNo">052</span> * </p><a name="line.52"></a> -<span class="sourceLineNo">053</span> *<a name="line.53"></a> -<span class="sourceLineNo">054</span> * <p><a name="line.54"></a> -<span class="sourceLineNo">055</span> * The default value pulls the description from the <code>contact</code> entry in the servlet resource bundle.<a name="line.55"></a> -<span class="sourceLineNo">056</span> * (e.g. <js>"contact = {name:'John Smith',email:'[email protected]'}"</js> or<a name="line.56"></a> -<span class="sourceLineNo">057</span> * <js>"MyServlet.contact = {name:'John Smith',email:'[email protected]'}"</js>).<a name="line.57"></a> -<span class="sourceLineNo">058</span> *<a name="line.58"></a> -<span class="sourceLineNo">059</span> * <h5 class='section'>Example:</h5><a name="line.59"></a> -<span class="sourceLineNo">060</span> * <p class='bcode'><a name="line.60"></a> -<span class="sourceLineNo">061</span> * <ja>@RestResource</ja>(<a name="line.61"></a> -<span class="sourceLineNo">062</span> * swagger=<ja>@MethodSwagger</ja>(<a name="line.62"></a> -<span class="sourceLineNo">063</span> * contact=<js>"{name:'John Smith',email:'[email protected]'}"</js><a name="line.63"></a> -<span class="sourceLineNo">064</span> * )<a name="line.64"></a> -<span class="sourceLineNo">065</span> * )<a name="line.65"></a> -<span class="sourceLineNo">066</span> * </p><a name="line.66"></a> -<span class="sourceLineNo">067</span> *<a name="line.67"></a> -<span class="sourceLineNo">068</span> * <p><a name="line.68"></a> -<span class="sourceLineNo">069</span> * This field can contain variables (e.g. "$L{my.localized.variable}").<a name="line.69"></a> -<span class="sourceLineNo">070</span> *<a name="line.70"></a> -<span class="sourceLineNo">071</span> * <p><a name="line.71"></a> -<span class="sourceLineNo">072</span> * Corresponds to the swagger field <code>/info/contact</code>.<a name="line.72"></a> +<span class="sourceLineNo">023</span> *<a name="line.23"></a> +<span class="sourceLineNo">024</span> * <p><a name="line.24"></a> +<span class="sourceLineNo">025</span> * It is used to populate the Swagger terms-of-service field.<a name="line.25"></a> +<span class="sourceLineNo">026</span> *<a name="line.26"></a> +<span class="sourceLineNo">027</span> * <p><a name="line.27"></a> +<span class="sourceLineNo">028</span> * The default value pulls the description from the <code>termsOfService</code> entry in the servlet resource bundle.<a name="line.28"></a> +<span class="sourceLineNo">029</span> * (e.g. <js>"termsOfService = foo"</js> or <js>"MyServlet.termsOfService = foo"</js>).<a name="line.29"></a> +<span class="sourceLineNo">030</span> *<a name="line.30"></a> +<span class="sourceLineNo">031</span> * <p><a name="line.31"></a> +<span class="sourceLineNo">032</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.32"></a> +<span class="sourceLineNo">033</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.33"></a> +<span class="sourceLineNo">034</span> *<a name="line.34"></a> +<span class="sourceLineNo">035</span> * <p><a name="line.35"></a> +<span class="sourceLineNo">036</span> * Corresponds to the swagger field <code>/info/termsOfService</code>.<a name="line.36"></a> +<span class="sourceLineNo">037</span> *<a name="line.37"></a> +<span class="sourceLineNo">038</span> * <p><a name="line.38"></a> +<span class="sourceLineNo">039</span> * The programmatic equivalent to this annotation is the {@link RestInfoProvider#getTermsOfService(RestRequest)}<a name="line.39"></a> +<span class="sourceLineNo">040</span> * method.<a name="line.40"></a> +<span class="sourceLineNo">041</span> */<a name="line.41"></a> +<span class="sourceLineNo">042</span> String termsOfService() default "";<a name="line.42"></a> +<span class="sourceLineNo">043</span><a name="line.43"></a> +<span class="sourceLineNo">044</span> /**<a name="line.44"></a> +<span class="sourceLineNo">045</span> * Optional contact information for the exposed API.<a name="line.45"></a> +<span class="sourceLineNo">046</span> *<a name="line.46"></a> +<span class="sourceLineNo">047</span> * <p><a name="line.47"></a> +<span class="sourceLineNo">048</span> * It is used to populate the Swagger contact field and to display on HTML pages.<a name="line.48"></a> +<span class="sourceLineNo">049</span> *<a name="line.49"></a> +<span class="sourceLineNo">050</span> * <p><a name="line.50"></a> +<span class="sourceLineNo">051</span> * A simplified JSON string with the following fields:<a name="line.51"></a> +<span class="sourceLineNo">052</span> * <p class='bcode'><a name="line.52"></a> +<span class="sourceLineNo">053</span> * {<a name="line.53"></a> +<span class="sourceLineNo">054</span> * name: string,<a name="line.54"></a> +<span class="sourceLineNo">055</span> * url: string,<a name="line.55"></a> +<span class="sourceLineNo">056</span> * email: string<a name="line.56"></a> +<span class="sourceLineNo">057</span> * }<a name="line.57"></a> +<span class="sourceLineNo">058</span> * </p><a name="line.58"></a> +<span class="sourceLineNo">059</span> *<a name="line.59"></a> +<span class="sourceLineNo">060</span> * <p><a name="line.60"></a> +<span class="sourceLineNo">061</span> * The default value pulls the description from the <code>contact</code> entry in the servlet resource bundle.<a name="line.61"></a> +<span class="sourceLineNo">062</span> * (e.g. <js>"contact = {name:'John Smith',email:'[email protected]'}"</js> or<a name="line.62"></a> +<span class="sourceLineNo">063</span> * <js>"MyServlet.contact = {name:'John Smith',email:'[email protected]'}"</js>).<a name="line.63"></a> +<span class="sourceLineNo">064</span> *<a name="line.64"></a> +<span class="sourceLineNo">065</span> * <h5 class='section'>Example:</h5><a name="line.65"></a> +<span class="sourceLineNo">066</span> * <p class='bcode'><a name="line.66"></a> +<span class="sourceLineNo">067</span> * <ja>@RestResource</ja>(<a name="line.67"></a> +<span class="sourceLineNo">068</span> * swagger=<ja>@MethodSwagger</ja>(<a name="line.68"></a> +<span class="sourceLineNo">069</span> * contact=<js>"{name:'John Smith',email:'[email protected]'}"</js><a name="line.69"></a> +<span class="sourceLineNo">070</span> * )<a name="line.70"></a> +<span class="sourceLineNo">071</span> * )<a name="line.71"></a> +<span class="sourceLineNo">072</span> * </p><a name="line.72"></a> <span class="sourceLineNo">073</span> *<a name="line.73"></a> <span class="sourceLineNo">074</span> * <p><a name="line.74"></a> -<span class="sourceLineNo">075</span> * The programmatic equivalent to this annotation is the {@link RestInfoProvider#getContact(RestRequest)} method.<a name="line.75"></a> -<span class="sourceLineNo">076</span> */<a name="line.76"></a> -<span class="sourceLineNo">077</span> String contact() default "";<a name="line.77"></a> -<span class="sourceLineNo">078</span><a name="line.78"></a> -<span class="sourceLineNo">079</span> /**<a name="line.79"></a> -<span class="sourceLineNo">080</span> * Optional license information for the exposed API.<a name="line.80"></a> -<span class="sourceLineNo">081</span> *<a name="line.81"></a> -<span class="sourceLineNo">082</span> * <p><a name="line.82"></a> -<span class="sourceLineNo">083</span> * It is used to populate the Swagger license field and to display on HTML pages.<a name="line.83"></a> -<span class="sourceLineNo">084</span> *<a name="line.84"></a> -<span class="sourceLineNo">085</span> * <p><a name="line.85"></a> -<span class="sourceLineNo">086</span> * A simplified JSON string with the following fields:<a name="line.86"></a> -<span class="sourceLineNo">087</span> * <p class='bcode'><a name="line.87"></a> -<span class="sourceLineNo">088</span> * {<a name="line.88"></a> -<span class="sourceLineNo">089</span> * name: string,<a name="line.89"></a> -<span class="sourceLineNo">090</span> * url: string<a name="line.90"></a> -<span class="sourceLineNo">091</span> * }<a name="line.91"></a> -<span class="sourceLineNo">092</span> * </p><a name="line.92"></a> -<span class="sourceLineNo">093</span> *<a name="line.93"></a> -<span class="sourceLineNo">094</span> * <p><a name="line.94"></a> -<span class="sourceLineNo">095</span> * The default value pulls the description from the <code>license</code> entry in the servlet resource bundle.<a name="line.95"></a> -<span class="sourceLineNo">096</span> * (e.g. <js>"license = {name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}"</js> or<a name="line.96"></a> -<span class="sourceLineNo">097</span> * <js>"MyServlet.license = {name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}"</js>).<a name="line.97"></a> -<span class="sourceLineNo">098</span> *<a name="line.98"></a> -<span class="sourceLineNo">099</span> * <h5 class='section'>Example:</h5><a name="line.99"></a> -<span class="sourceLineNo">100</span> * <p class='bcode'><a name="line.100"></a> -<span class="sourceLineNo">101</span> * <ja>@RestResource</ja>(<a name="line.101"></a> -<span class="sourceLineNo">102</span> * swagger=<ja>@MethodSwagger</ja>(<a name="line.102"></a> -<span class="sourceLineNo">103</span> * license=<js>"{name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}"</js><a name="line.103"></a> -<span class="sourceLineNo">104</span> * )<a name="line.104"></a> -<span class="sourceLineNo">105</span> * )<a name="line.105"></a> -<span class="sourceLineNo">106</span> * </p><a name="line.106"></a> -<span class="sourceLineNo">107</span> *<a name="line.107"></a> -<span class="sourceLineNo">108</span> * <p><a name="line.108"></a> -<span class="sourceLineNo">109</span> * This field can contain variables (e.g. "$L{my.localized.variable}").<a name="line.109"></a> -<span class="sourceLineNo">110</span> *<a name="line.110"></a> -<span class="sourceLineNo">111</span> * <p><a name="line.111"></a> -<span class="sourceLineNo">112</span> * Corresponds to the swagger field <code>/info/license</code>.<a name="line.112"></a> -<span class="sourceLineNo">113</span> *<a name="line.113"></a> -<span class="sourceLineNo">114</span> * <p><a name="line.114"></a> -<span class="sourceLineNo">115</span> * The programmatic equivalent to this annotation is the {@link RestInfoProvider#getLicense(RestRequest)} method.<a name="line.115"></a> -<span class="sourceLineNo">116</span> */<a name="line.116"></a> -<span class="sourceLineNo">117</span> String license() default "";<a name="line.117"></a> -<span class="sourceLineNo">118</span><a name="line.118"></a> -<span class="sourceLineNo">119</span> /**<a name="line.119"></a> -<span class="sourceLineNo">120</span> * Provides the version of the application API (not to be confused with the specification version).<a name="line.120"></a> +<span class="sourceLineNo">075</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.75"></a> +<span class="sourceLineNo">076</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.76"></a> +<span class="sourceLineNo">077</span> *<a name="line.77"></a> +<span class="sourceLineNo">078</span> * <p><a name="line.78"></a> +<span class="sourceLineNo">079</span> * Corresponds to the swagger field <code>/info/contact</code>.<a name="line.79"></a> +<span class="sourceLineNo">080</span> *<a name="line.80"></a> +<span class="sourceLineNo">081</span> * <p><a name="line.81"></a> +<span class="sourceLineNo">082</span> * The programmatic equivalent to this annotation is the {@link RestInfoProvider#getContact(RestRequest)} method.<a name="line.82"></a> +<span class="sourceLineNo">083</span> */<a name="line.83"></a> +<span class="sourceLineNo">084</span> String contact() default "";<a name="line.84"></a> +<span class="sourceLineNo">085</span><a name="line.85"></a> +<span class="sourceLineNo">086</span> /**<a name="line.86"></a> +<span class="sourceLineNo">087</span> * Optional license information for the exposed API.<a name="line.87"></a> +<span class="sourceLineNo">088</span> *<a name="line.88"></a> +<span class="sourceLineNo">089</span> * <p><a name="line.89"></a> +<span class="sourceLineNo">090</span> * It is used to populate the Swagger license field and to display on HTML pages.<a name="line.90"></a> +<span class="sourceLineNo">091</span> *<a name="line.91"></a> +<span class="sourceLineNo">092</span> * <p><a name="line.92"></a> +<span class="sourceLineNo">093</span> * A simplified JSON string with the following fields:<a name="line.93"></a> +<span class="sourceLineNo">094</span> * <p class='bcode'><a name="line.94"></a> +<span class="sourceLineNo">095</span> * {<a name="line.95"></a> +<span class="sourceLineNo">096</span> * name: string,<a name="line.96"></a> +<span class="sourceLineNo">097</span> * url: string<a name="line.97"></a> +<span class="sourceLineNo">098</span> * }<a name="line.98"></a> +<span class="sourceLineNo">099</span> * </p><a name="line.99"></a> +<span class="sourceLineNo">100</span> *<a name="line.100"></a> +<span class="sourceLineNo">101</span> * <p><a name="line.101"></a> +<span class="sourceLineNo">102</span> * The default value pulls the description from the <code>license</code> entry in the servlet resource bundle.<a name="line.102"></a> +<span class="sourceLineNo">103</span> * (e.g. <js>"license = {name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}"</js> or<a name="line.103"></a> +<span class="sourceLineNo">104</span> * <js>"MyServlet.license = {name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}"</js>).<a name="line.104"></a> +<span class="sourceLineNo">105</span> *<a name="line.105"></a> +<span class="sourceLineNo">106</span> * <h5 class='section'>Example:</h5><a name="line.106"></a> +<span class="sourceLineNo">107</span> * <p class='bcode'><a name="line.107"></a> +<span class="sourceLineNo">108</span> * <ja>@RestResource</ja>(<a name="line.108"></a> +<span class="sourceLineNo">109</span> * swagger=<ja>@MethodSwagger</ja>(<a name="line.109"></a> +<span class="sourceLineNo">110</span> * license=<js>"{name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}"</js><a name="line.110"></a> +<span class="sourceLineNo">111</span> * )<a name="line.111"></a> +<span class="sourceLineNo">112</span> * )<a name="line.112"></a> +<span class="sourceLineNo">113</span> * </p><a name="line.113"></a> +<span class="sourceLineNo">114</span> *<a name="line.114"></a> +<span class="sourceLineNo">115</span> * <p><a name="line.115"></a> +<span class="sourceLineNo">116</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.116"></a> +<span class="sourceLineNo">117</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.117"></a> +<span class="sourceLineNo">118</span> *<a name="line.118"></a> +<span class="sourceLineNo">119</span> * <p><a name="line.119"></a> +<span class="sourceLineNo">120</span> * Corresponds to the swagger field <code>/info/license</code>.<a name="line.120"></a> <span class="sourceLineNo">121</span> *<a name="line.121"></a> <span class="sourceLineNo">122</span> * <p><a name="line.122"></a> -<span class="sourceLineNo">123</span> * It is used to populate the Swagger version field and to display on HTML pages.<a name="line.123"></a> -<span class="sourceLineNo">124</span> *<a name="line.124"></a> -<span class="sourceLineNo">125</span> * <p><a name="line.125"></a> -<span class="sourceLineNo">126</span> * The default value pulls the description from the <code>version</code> entry in the servlet resource bundle.<a name="line.126"></a> -<span class="sourceLineNo">127</span> * (e.g. <js>"version = 2.0"</js> or <js>"MyServlet.version = 2.0"</js>).<a name="line.127"></a> -<span class="sourceLineNo">128</span> *<a name="line.128"></a> -<span class="sourceLineNo">129</span> * <p><a name="line.129"></a> -<span class="sourceLineNo">130</span> * This field can contain variables (e.g. "$L{my.localized.variable}").<a name="line.130"></a> -<span class="sourceLineNo">131</span> *<a name="line.131"></a> -<span class="sourceLineNo">132</span> * <p><a name="line.132"></a> -<span class="sourceLineNo">133</span> * Corresponds to the swagger field <code>/info/version</code>.<a name="line.133"></a> -<span class="sourceLineNo">134</span> *<a name="line.134"></a> -<span class="sourceLineNo">135</span> * <p><a name="line.135"></a> -<span class="sourceLineNo">136</span> * The programmatic equivalent to this annotation is the {@link RestInfoProvider#getVersion(RestRequest)} method.<a name="line.136"></a> -<span class="sourceLineNo">137</span> */<a name="line.137"></a> -<span class="sourceLineNo">138</span> String version() default "";<a name="line.138"></a> -<span class="sourceLineNo">139</span><a name="line.139"></a> -<span class="sourceLineNo">140</span> /**<a name="line.140"></a> -<span class="sourceLineNo">141</span> * Optional tagging information for the exposed API.<a name="line.141"></a> -<span class="sourceLineNo">142</span> *<a name="line.142"></a> -<span class="sourceLineNo">143</span> * <p><a name="line.143"></a> -<span class="sourceLineNo">144</span> * It is used to populate the Swagger tags field and to display on HTML pages.<a name="line.144"></a> -<span class="sourceLineNo">145</span> *<a name="line.145"></a> -<span class="sourceLineNo">146</span> * <p><a name="line.146"></a> -<span class="sourceLineNo">147</span> * A simplified JSON string with the following fields:<a name="line.147"></a> -<span class="sourceLineNo">148</span> * <p class='bcode'><a name="line.148"></a> -<span class="sourceLineNo">149</span> * [<a name="line.149"></a> -<span class="sourceLineNo">150</span> * {<a name="line.150"></a> -<span class="sourceLineNo">151</span> * name: string,<a name="line.151"></a> -<span class="sourceLineNo">152</span> * description: string,<a name="line.152"></a> -<span class="sourceLineNo">153</span> * externalDocs: {<a name="line.153"></a> -<span class="sourceLineNo">154</span> * description: string,<a name="line.154"></a> -<span class="sourceLineNo">155</span> * url: string<a name="line.155"></a> -<span class="sourceLineNo">156</span> * }<a name="line.156"></a> -<span class="sourceLineNo">157</span> * }<a name="line.157"></a> -<span class="sourceLineNo">158</span> * ]<a name="line.158"></a> -<span class="sourceLineNo">159</span> * </p><a name="line.159"></a> -<span class="sourceLineNo">160</span> *<a name="line.160"></a> -<span class="sourceLineNo">161</span> * <p><a name="line.161"></a> -<span class="sourceLineNo">162</span> * The default value pulls the description from the <code>tags</code> entry in the servlet resource bundle.<a name="line.162"></a> -<span class="sourceLineNo">163</span> * (e.g. <js>"tags = [{name:'Foo',description:'Foobar'}]"</js> or<a name="line.163"></a> -<span class="sourceLineNo">164</span> * <js>"MyServlet.tags = [{name:'Foo',description:'Foobar'}]"</js>).<a name="line.164"></a> -<span class="sourceLineNo">165</span> *<a name="line.165"></a> -<span class="sourceLineNo">166</span> * <h5 class='section'>Example:</h5><a name="line.166"></a> -<span class="sourceLineNo">167</span> * <p class='bcode'><a name="line.167"></a> -<span class="sourceLineNo">168</span> * <ja>@RestResource</ja>(<a name="line.168"></a> -<span class="sourceLineNo">169</span> * swagger=<ja>@MethodSwagger</ja>(<a name="line.169"></a> -<span class="sourceLineNo">170</span> * tags=<js>"[{name:'Foo',description:'Foobar'}]"</js><a name="line.170"></a> -<span class="sourceLineNo">171</span> * )<a name="line.171"></a> -<span class="sourceLineNo">172</span> * )<a name="line.172"></a> -<span class="sourceLineNo">173</span> * </p><a name="line.173"></a> +<span class="sourceLineNo">123</span> * The programmatic equivalent to this annotation is the {@link RestInfoProvider#getLicense(RestRequest)} method.<a name="line.123"></a> +<span class="sourceLineNo">124</span> */<a name="line.124"></a> +<span class="sourceLineNo">125</span> String license() default "";<a name="line.125"></a> +<span class="sourceLineNo">126</span><a name="line.126"></a> +<span class="sourceLineNo">127</span> /**<a name="line.127"></a> +<span class="sourceLineNo">128</span> * Provides the version of the application API (not to be confused with the specification version).<a name="line.128"></a> +<span class="sourceLineNo">129</span> *<a name="line.129"></a> +<span class="sourceLineNo">130</span> * <p><a name="line.130"></a> +<span class="sourceLineNo">131</span> * It is used to populate the Swagger version field and to display on HTML pages.<a name="line.131"></a> +<span class="sourceLineNo">132</span> *<a name="line.132"></a> +<span class="sourceLineNo">133</span> * <p><a name="line.133"></a> +<span class="sourceLineNo">134</span> * The default value pulls the description from the <code>version</code> entry in the servlet resource bundle.<a name="line.134"></a> +<span class="sourceLineNo">135</span> * (e.g. <js>"version = 2.0"</js> or <js>"MyServlet.version = 2.0"</js>).<a name="line.135"></a> +<span class="sourceLineNo">136</span> *<a name="line.136"></a> +<span class="sourceLineNo">137</span> * <p><a name="line.137"></a> +<span class="sourceLineNo">138</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.138"></a> +<span class="sourceLineNo">139</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.139"></a> +<span class="sourceLineNo">140</span> *<a name="line.140"></a> +<span class="sourceLineNo">141</span> * <p><a name="line.141"></a> +<span class="sourceLineNo">142</span> * Corresponds to the swagger field <code>/info/version</code>.<a name="line.142"></a> +<span class="sourceLineNo">143</span> *<a name="line.143"></a> +<span class="sourceLineNo">144</span> * <p><a name="line.144"></a> +<span class="sourceLineNo">145</span> * The programmatic equivalent to this annotation is the {@link RestInfoProvider#getVersion(RestRequest)} method.<a name="line.145"></a> +<span class="sourceLineNo">146</span> */<a name="line.146"></a> +<span class="sourceLineNo">147</span> String version() default "";<a name="line.147"></a> +<span class="sourceLineNo">148</span><a name="line.148"></a> +<span class="sourceLineNo">149</span> /**<a name="line.149"></a> +<span class="sourceLineNo">150</span> * Optional tagging information for the exposed API.<a name="line.150"></a> +<span class="sourceLineNo">151</span> *<a name="line.151"></a> +<span class="sourceLineNo">152</span> * <p><a name="line.152"></a> +<span class="sourceLineNo">153</span> * It is used to populate the Swagger tags field and to display on HTML pages.<a name="line.153"></a> +<span class="sourceLineNo">154</span> *<a name="line.154"></a> +<span class="sourceLineNo">155</span> * <p><a name="line.155"></a> +<span class="sourceLineNo">156</span> * A simplified JSON string with the following fields:<a name="line.156"></a> +<span class="sourceLineNo">157</span> * <p class='bcode'><a name="line.157"></a> +<span class="sourceLineNo">158</span> * [<a name="line.158"></a> +<span class="sourceLineNo">159</span> * {<a name="line.159"></a> +<span class="sourceLineNo">160</span> * name: string,<a name="line.160"></a> +<span class="sourceLineNo">161</span> * description: string,<a name="line.161"></a> +<span class="sourceLineNo">162</span> * externalDocs: {<a name="line.162"></a> +<span class="sourceLineNo">163</span> * description: string,<a name="line.163"></a> +<span class="sourceLineNo">164</span> * url: string<a name="line.164"></a> +<span class="sourceLineNo">165</span> * }<a name="line.165"></a> +<span class="sourceLineNo">166</span> * }<a name="line.166"></a> +<span class="sourceLineNo">167</span> * ]<a name="line.167"></a> +<span class="sourceLineNo">168</span> * </p><a name="line.168"></a> +<span class="sourceLineNo">169</span> *<a name="line.169"></a> +<span class="sourceLineNo">170</span> * <p><a name="line.170"></a> +<span class="sourceLineNo">171</span> * The default value pulls the description from the <code>tags</code> entry in the servlet resource bundle.<a name="line.171"></a> +<span class="sourceLineNo">172</span> * (e.g. <js>"tags = [{name:'Foo',description:'Foobar'}]"</js> or<a name="line.172"></a> +<span class="sourceLineNo">173</span> * <js>"MyServlet.tags = [{name:'Foo',description:'Foobar'}]"</js>).<a name="line.173"></a> <span class="sourceLineNo">174</span> *<a name="line.174"></a> -<span class="sourceLineNo">175</span> * <p><a name="line.175"></a> -<span class="sourceLineNo">176</span> * This field can contain variables (e.g. "$L{my.localized.variable}").<a name="line.176"></a> -<span class="sourceLineNo">177</span> *<a name="line.177"></a> -<span class="sourceLineNo">178</span> * <p><a name="line.178"></a> -<span class="sourceLineNo">179</span> * Corresponds to the swagger field <code>/tags</code>.<a name="line.179"></a> -<span class="sourceLineNo">180</span> *<a name="line.180"></a> -<span class="sourceLineNo">181</span> * <p><a name="line.181"></a> -<span class="sourceLineNo">182</span> * The programmatic equivalent to this annotation is the {@link RestInfoProvider#getTags(RestRequest)} method.<a name="line.182"></a> -<span class="sourceLineNo">183</span> */<a name="line.183"></a> -<span class="sourceLineNo">184</span> String tags() default "";<a name="line.184"></a> -<span class="sourceLineNo">185</span><a name="line.185"></a> -<span class="sourceLineNo">186</span> /**<a name="line.186"></a> -<span class="sourceLineNo">187</span> * Optional external documentation information for the exposed API.<a name="line.187"></a> -<span class="sourceLineNo">188</span> *<a name="line.188"></a> -<span class="sourceLineNo">189</span> * <p><a name="line.189"></a> -<span class="sourceLineNo">190</span> * It is used to populate the Swagger external documentation field and to display on HTML pages.<a name="line.190"></a> -<span class="sourceLineNo">191</span> *<a name="line.191"></a> -<span class="sourceLineNo">192</span> * <p><a name="line.192"></a> -<span class="sourceLineNo">193</span> * A simplified JSON string with the following fields:<a name="line.193"></a> -<span class="sourceLineNo">194</span> * <p class='bcode'><a name="line.194"></a> -<span class="sourceLineNo">195</span> * {<a name="line.195"></a> -<span class="sourceLineNo">196</span> * description: string,<a name="line.196"></a> -<span class="sourceLineNo">197</span> * url: string<a name="line.197"></a> -<span class="sourceLineNo">198</span> * }<a name="line.198"></a> -<span class="sourceLineNo">199</span> * </p><a name="line.199"></a> -<span class="sourceLineNo">200</span> *<a name="line.200"></a> -<span class="sourceLineNo">201</span> * <p><a name="line.201"></a> -<span class="sourceLineNo">202</span> * The default value pulls the description from the <code>externalDocs</code> entry in the servlet resource bundle.<a name="line.202"></a> -<span class="sourceLineNo">203</span> * (e.g. <js>"externalDocs = {url:'http://juneau.apache.org'}"</js> or<a name="line.203"></a> -<span class="sourceLineNo">204</span> * <js>"MyServlet.externalDocs = {url:'http://juneau.apache.org'}"</js>).<a name="line.204"></a> -<span class="sourceLineNo">205</span> *<a name="line.205"></a> -<span class="sourceLineNo">206</span> * <h5 class='section'>Example:</h5><a name="line.206"></a> -<span class="sourceLineNo">207</span> * <p class='bcode'><a name="line.207"></a> -<span class="sourceLineNo">208</span> * <ja>@RestResource</ja>(<a name="line.208"></a> -<span class="sourceLineNo">209</span> * swagger=<ja>@MethodSwagger</ja>(<a name="line.209"></a> -<span class="sourceLineNo">210</span> * externalDocs=<js>"{url:'http://juneau.apache.org'}"</js><a name="line.210"></a> -<span class="sourceLineNo">211</span> * )<a name="line.211"></a> -<span class="sourceLineNo">212</span> * )<a name="line.212"></a> -<span class="sourceLineNo">213</span> * </p><a name="line.213"></a> -<span class="sourceLineNo">214</span> *<a name="line.214"></a> -<span class="sourceLineNo">215</span> * <p><a name="line.215"></a> -<span class="sourceLineNo">216</span> * This field can contain variables (e.g. "$L{my.localized.variable}").<a name="line.216"></a> -<span class="sourceLineNo">217</span> *<a name="line.217"></a> -<span class="sourceLineNo">218</span> * <p><a name="line.218"></a> -<span class="sourceLineNo">219</span> * Corresponds to the swagger field <code>/tags</code>.<a name="line.219"></a> -<span class="sourceLineNo">220</span> *<a name="line.220"></a> -<span class="sourceLineNo">221</span> * <p><a name="line.221"></a> -<span class="sourceLineNo">222</span> * The programmatic equivalent to this annotation is the {@link RestInfoProvider#getExternalDocs(RestRequest)}<a name="line.222"></a> -<span class="sourceLineNo">223</span> * method.<a name="line.223"></a> -<span class="sourceLineNo">224</span> */<a name="line.224"></a> -<span class="sourceLineNo">225</span> String externalDocs() default "";<a name="line.225"></a> -<span class="sourceLineNo">226</span>}<a name="line.226"></a> +<span class="sourceLineNo">175</span> * <h5 class='section'>Example:</h5><a name="line.175"></a> +<span class="sourceLineNo">176</span> * <p class='bcode'><a name="line.176"></a> +<span class="sourceLineNo">177</span> * <ja>@RestResource</ja>(<a name="line.177"></a> +<span class="sourceLineNo">178</span> * swagger=<ja>@MethodSwagger</ja>(<a name="line.178"></a> +<span class="sourceLineNo">179</span> * tags=<js>"[{name:'Foo',description:'Foobar'}]"</js><a name="line.179"></a> +<span class="sourceLineNo">180</span> * )<a name="line.180"></a> +<span class="sourceLineNo">181</span> * )<a name="line.181"></a> +<span class="sourceLineNo">182</span> * </p><a name="line.182"></a> +<span class="sourceLineNo">183</span> *<a name="line.183"></a> +<span class="sourceLineNo">184</span> * <p><a name="line.184"></a> +<span class="sourceLineNo">185</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.185"></a> +<span class="sourceLineNo">186</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.186"></a> +<span class="sourceLineNo">187</span> *<a name="line.187"></a> +<span class="sourceLineNo">188</span> * <p><a name="line.188"></a> +<span class="sourceLineNo">189</span> * Corresponds to the swagger field <code>/tags</code>.<a name="line.189"></a> +<span class="sourceLineNo">190</span> *<a name="line.190"></a> +<span class="sourceLineNo">191</span> * <p><a name="line.191"></a> +<span class="sourceLineNo">192</span> * The programmatic equivalent to this annotation is the {@link RestInfoProvider#getTags(RestRequest)} method.<a name="line.192"></a> +<span class="sourceLineNo">193</span> */<a name="line.193"></a> +<span class="sourceLineNo">194</span> String tags() default "";<a name="line.194"></a> +<span class="sourceLineNo">195</span><a name="line.195"></a> +<span class="sourceLineNo">196</span> /**<a name="line.196"></a> +<span class="sourceLineNo">197</span> * Optional external documentation information for the exposed API.<a name="line.197"></a> +<span class="sourceLineNo">198</span> *<a name="line.198"></a> +<span class="sourceLineNo">199</span> * <p><a name="line.199"></a> +<span class="sourceLineNo">200</span> * It is used to populate the Swagger external documentation field and to display on HTML pages.<a name="line.200"></a> +<span class="sourceLineNo">201</span> *<a name="line.201"></a> +<span class="sourceLineNo">202</span> * <p><a name="line.202"></a> +<span class="sourceLineNo">203</span> * A simplified JSON string with the following fields:<a name="line.203"></a> +<span class="sourceLineNo">204</span> * <p class='bcode'><a name="line.204"></a> +<span class="sourceLineNo">205</span> * {<a name="line.205"></a> +<span class="sourceLineNo">206</span> * description: string,<a name="line.206"></a> +<span class="sourceLineNo">207</span> * url: string<a name="line.207"></a> +<span class="sourceLineNo">208</span> * }<a name="line.208"></a> +<span class="sourceLineNo">209</span> * </p><a name="line.209"></a> +<span class="sourceLineNo">210</span> *<a name="line.210"></a> +<span class="sourceLineNo">211</span> * <p><a name="line.211"></a> +<span class="sourceLineNo">212</span> * The default value pulls the description from the <code>externalDocs</code> entry in the servlet resource bundle.<a name="line.212"></a> +<span class="sourceLineNo">213</span> * (e.g. <js>"externalDocs = {url:'http://juneau.apache.org'}"</js> or<a name="line.213"></a> +<span class="sourceLineNo">214</span> * <js>"MyServlet.externalDocs = {url:'http://juneau.apache.org'}"</js>).<a name="line.214"></a> +<span class="sourceLineNo">215</span> *<a name="line.215"></a> +<span class="sourceLineNo">216</span> * <h5 class='section'>Example:</h5><a name="line.216"></a> +<span class="sourceLineNo">217</span> * <p class='bcode'><a name="line.217"></a> +<span class="sourceLineNo">218</span> * <ja>@RestResource</ja>(<a name="line.218"></a> +<span class="sourceLineNo">219</span> * swagger=<ja>@MethodSwagger</ja>(<a name="line.219"></a> +<span class="sourceLineNo">220</span> * externalDocs=<js>"{url:'http://juneau.apache.org'}"</js><a name="line.220"></a> +<span class="sourceLineNo">221</span> * )<a name="line.221"></a> +<span class="sourceLineNo">222</span> * )<a name="line.222"></a> +<span class="sourceLineNo">223</span> * </p><a name="line.223"></a> +<span class="sourceLineNo">224</span> *<a name="line.224"></a> +<span class="sourceLineNo">225</span> * <p><a name="line.225"></a> +<span class="sourceLineNo">226</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.226"></a> +<span class="sourceLineNo">227</span> * See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.227"></a> +<span class="sourceLineNo">228</span> *<a name="line.228"></a> +<span class="sourceLineNo">229</span> * <p><a name="line.229"></a> +<span class="sourceLineNo">230</span> * Corresponds to the swagger field <code>/tags</code>.<a name="line.230"></a> +<span class="sourceLineNo">231</span> *<a name="line.231"></a> +<span class="sourceLineNo">232</span> * <p><a name="line.232"></a> +<span class="sourceLineNo">233</span> * The programmatic equivalent to this annotation is the {@link RestInfoProvider#getExternalDocs(RestRequest)}<a name="line.233"></a> +<span class="sourceLineNo">234</span> * method.<a name="line.234"></a> +<span class="sourceLineNo">235</span> */<a name="line.235"></a> +<span class="sourceLineNo">236</span> String externalDocs() default "";<a name="line.236"></a> +<span class="sourceLineNo">237</span>}<a name="line.237"></a>
