You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2018/05/21 22:17:45 UTC
[juneau] branch master updated: Javadocs
This is an automated email from the ASF dual-hosted git repository.
jamesbognar pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/juneau.git
The following commit(s) were added to refs/heads/master by this push:
new fe6ee38 Javadocs
fe6ee38 is described below
commit fe6ee38b449550148d84da0050a3699b7eacdaaf
Author: JamesBognar <ja...@apache.org>
AuthorDate: Mon May 21 18:17:26 2018 -0400
Javadocs
---
.../org/apache/juneau/dto/swagger/HeaderInfo.java | 12 ++-
.../java/org/apache/juneau/dto/swagger/Items.java | 8 ++
.../apache/juneau/dto/swagger/ParameterInfo.java | 12 ++-
.../org/apache/juneau/dto/swagger/SchemaInfo.java | 34 +++++++-
.../apache/juneau/dto/swagger/SecurityScheme.java | 3 -
.../org/apache/juneau/rest/annotation/Body.java | 91 ++++++++++++++++++++++
.../apache/juneau/rest/annotation/FormData.java | 15 +++-
.../org/apache/juneau/rest/annotation/Header.java | 15 +++-
.../juneau/rest/annotation/MethodSwagger.java | 1 -
.../org/apache/juneau/rest/annotation/Path.java | 12 +++
.../org/apache/juneau/rest/annotation/Query.java | 15 +++-
.../juneau/rest/annotation/ResponseHeader.java | 10 +++
12 files changed, 215 insertions(+), 13 deletions(-)
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java
index cdf41a3..04fb012 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java
@@ -189,6 +189,11 @@ public class HeaderInfo extends SwaggerElement {
* <p>
* The type of the object.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul class='doctree'>
+ * <li class='link'><a class='doclink' href='https://swagger.io/specification/#dataTypes'>Swagger specification > Data Types</a>
+ * </ul>
+ *
* @param value
* The new value for this property.
* <br>Property value is required.
@@ -249,8 +254,8 @@ public class HeaderInfo extends SwaggerElement {
* The extending format for the previously mentioned <code>type</code>.
*
* <h5 class='section'>See Also:</h5>
- * <ul>
- * <li class='extlink'><a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a>
+ * <ul class='doctree'>
+ * <li class='link'><a class='doclink' href='https://swagger.io/specification/#dataTypes'>Swagger specification > Data Types</a>
* </ul>
*
* @param value
@@ -729,6 +734,9 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>pattern</property>.
*
+ * <p>
+ * This string SHOULD be a valid regular expression.
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='extlink'><a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor33">http://json-schema.org/latest/json-schema-validation.html#anchor33</a>
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Items.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Items.java
index 544c492..2680b2a 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Items.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Items.java
@@ -146,6 +146,11 @@ public class Items extends SwaggerElement {
* <p>
* The internal type of the array.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul class='doctree'>
+ * <li class='link'><a class='doclink' href='https://swagger.io/specification/#dataTypes'>Swagger specification > Data Types</a>
+ * </ul>
+ *
* @param value
* The new value for this property.
* <br>Valid values:
@@ -704,6 +709,9 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>pattern</property>.
*
+ * <p>
+ * This string SHOULD be a valid regular expression.
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='extlink'><a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor33">http://json-schema.org/latest/json-schema-validation.html#anchor33</a>
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java
index 5264d7e..8a6335f 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java
@@ -546,6 +546,11 @@ public class ParameterInfo extends SwaggerElement {
* <p>
* The type of the parameter.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul class='doctree'>
+ * <li class='link'><a class='doclink' href='https://swagger.io/specification/#dataTypes'>Swagger specification > Data Types</a>
+ * </ul>
+ *
* @param value
* The new value for this property.
* <br>Valid values:
@@ -620,8 +625,8 @@ public class ParameterInfo extends SwaggerElement {
* The extending format for the previously mentioned type.
*
* <h5 class='section'>See Also:</h5>
- * <ul>
- * <li class='extlink'><a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a>
+ * <ul class='doctree'>
+ * <li class='link'><a class='doclink' href='https://swagger.io/specification/#dataTypes'>Swagger specification > Data Types</a>
* </ul>
*
* @param value The new value for this property.
@@ -1141,6 +1146,9 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>pattern</property>.
*
+ * <p>
+ * This string SHOULD be a valid regular expression.
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='extlink'><a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor33">http://json-schema.org/latest/json-schema-validation.html#anchor33</a>
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java
index 8e970b2..d0b092d 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java
@@ -175,13 +175,25 @@ public class SchemaInfo extends SwaggerElement {
* Bean property setter: <property>format</property>.
*
* <h5 class='section'>See Also:</h5>
- * <ul>
- * <li class='extlink'><a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a>
+ * <ul class='doctree'>
+ * <li class='link'><a class='doclink' href='https://swagger.io/specification/#dataTypes'>Swagger specification > Data Types</a>
* </ul>
*
* @param value
* The new value for this property.
* <br>Can be <jk>null</jk> to unset the property.
+ * <br>Formats defined by the OAS include:
+ * <ul>
+ * <li><js>"int32"</js>
+ * <li><js>"int64"</js>
+ * <li><js>"float"</js>
+ * <li><js>"double"</js>
+ * <li><js>"byte"</js>
+ * <li><js>"binary"</js>
+ * <li><js>"date"</js>
+ * <li><js>"date-time"</js>
+ * <li><js>"password"</js>
+ * </ul>
* @return This object (for method chaining).
*/
public SchemaInfo setFormat(String value) {
@@ -568,6 +580,9 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>pattern</property>.
*
+ * <p>
+ * This string SHOULD be a valid regular expression.
+ *
* @param value
* The new value for this property.
* <br>Can be <jk>null</jk> to unset the property.
@@ -922,9 +937,24 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>type</property>.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul class='doctree'>
+ * <li class='link'><a class='doclink' href='https://swagger.io/specification/#dataTypes'>Swagger specification > Data Types</a>
+ * </ul>
+ *
* @param value
* The new value for this property.
* <br>Can be <jk>null</jk> to unset the property.
+ * <br>Possible values include:
+ * <ul>
+ * <li><js>"object"</js>
+ * <li><js>"string"</js>
+ * <li><js>"number"</js>
+ * <li><js>"integer"</js>
+ * <li><js>"boolean"</js>
+ * <li><js>"array"</js>
+ * <li><js>"file"</js>
+ * </ul>
* @return This object (for method chaining).
*/
public SchemaInfo setType(String value) {
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java
index 0b80e45..320e809 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java
@@ -135,9 +135,6 @@ public class SecurityScheme extends SwaggerElement {
* <p>
* The type of the security scheme.
*
- * <p>
- * Valid values are .
- *
* @param value
* The new value for this property.
* <br>Valid values:
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Body.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Body.java
index 94fe526..8300e60 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Body.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Body.java
@@ -133,6 +133,19 @@ public @interface Body {
/**
* Defines the swagger value <code>/paths/{path}/{method}/parameters/#/description</code>.
*
+ * <h5 class='section'>Examples:</h5>
+ * <p class='bcode'>
+ * <ja>@RestMethod</ja>(name=<jsf>PUT</jsf>)
+ * <jk>public void</jk> doPut(<ja>@Body</ja>(description=<js>"A description"</js>) MyBean input) {...}
+ * </p>
+ * <p class='bcode'>
+ * <ja>@RestMethod</ja>(name=<jsf>PUT</jsf>)
+ * <jk>public void</jk> doPut(MyBean input) {...}
+ *
+ * <ja>@Body</ja>(description=<js>"A description"</js>)
+ * <jk>public class</jk> MyBean {...}
+ * </p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
@@ -148,6 +161,19 @@ public @interface Body {
/**
* Defines the swagger value <code>/paths/{path}/{method}/parameters/#/required</code>.
*
+ * <h5 class='section'>Examples:</h5>
+ * <p class='bcode'>
+ * <ja>@RestMethod</ja>(name=<jsf>PUT</jsf>)
+ * <jk>public void</jk> doPut(<ja>@Body</ja>(required=<js>"true"</js>) MyBean input) {...}
+ * </p>
+ * <p class='bcode'>
+ * <ja>@RestMethod</ja>(name=<jsf>PUT</jsf>)
+ * <jk>public void</jk> doPut(MyBean input) {...}
+ *
+ * <ja>@Body</ja>(required=<js>"true"</js>)
+ * <jk>public class</jk> MyBean {...}
+ * </p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
@@ -162,11 +188,25 @@ public @interface Body {
/**
* Defines the swagger value <code>/paths/{path}/{method}/parameters/#/type</code>.
*
+ * <h5 class='section'>Examples:</h5>
+ * <p class='bcode'>
+ * <ja>@RestMethod</ja>(name=<jsf>PUT</jsf>)
+ * <jk>public void</jk> doPut(<ja>@Body</ja>(type=<js>"object"</js>) MyBean input) {...}
+ * </p>
+ * <p class='bcode'>
+ * <ja>@RestMethod</ja>(name=<jsf>PUT</jsf>)
+ * <jk>public void</jk> doPut(MyBean input) {...}
+ *
+ * <ja>@Body</ja>(type=<js>"object"</js>)
+ * <jk>public class</jk> MyBean {...}
+ * </p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
* The possible values are:
* <ul>
+ * <li><js>"object"</js>
* <li><js>"string"</js>
* <li><js>"number"</js>
* <li><js>"integer"</js>
@@ -178,12 +218,31 @@ public @interface Body {
* Supports <a class="doclink" href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time and request-time variables</a>
* (e.g. <js>"$L{my.localized.variable}"</js>).
* </ul>
+ *
+ * <h5 class='section'>See Also:</h5>
+ * <ul class='doctree'>
+ * <li class='link'><a class='doclink' href='https://swagger.io/specification/#dataTypes'>Swagger specification > Data Types</a>
+ * </ul>
+ *
*/
String type() default "";
/**
* Defines the swagger value <code>/paths/{path}/{method}/parameters/#/format</code>.
*
+ * <h5 class='section'>Examples:</h5>
+ * <p class='bcode'>
+ * <ja>@RestMethod</ja>(name=<jsf>PUT</jsf>)
+ * <jk>public void</jk> doPut(<ja>@Body</ja>(type=<js>"object"</js>) MyBean input) {...}
+ * </p>
+ * <p class='bcode'>
+ * <ja>@RestMethod</ja>(name=<jsf>PUT</jsf>)
+ * <jk>public void</jk> doPut(MyBean input) {...}
+ *
+ * <ja>@Body</ja>(type=<js>"object"</js>)
+ * <jk>public class</jk> MyBean {...}
+ * </p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
@@ -191,6 +250,24 @@ public @interface Body {
* <li>
* Supports <a class="doclink" href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time and request-time variables</a>
* (e.g. <js>"$L{my.localized.variable}"</js>).
+ * <li>
+ * Formats defined by the OAS include:
+ * <ul>
+ * <li><js>"int32"</js>
+ * <li><js>"int64"</js>
+ * <li><js>"float"</js>
+ * <li><js>"double"</js>
+ * <li><js>"byte"</js>
+ * <li><js>"binary"</js>
+ * <li><js>"date"</js>
+ * <li><js>"date-time"</js>
+ * <li><js>"password"</js>
+ * </ul>
+ * </ul>
+ *
+ * <h5 class='section'>See Also:</h5>
+ * <ul class='doctree'>
+ * <li class='link'><a class='doclink' href='https://swagger.io/specification/#dataTypes'>Swagger specification > Data Types</a>
* </ul>
*/
String format() default "";
@@ -198,11 +275,19 @@ public @interface Body {
/**
* Defines the swagger value <code>/paths/{path}/{method}/parameters/#/pattern</code>.
*
+ * <h5 class='section'>Example:</h5>
+ * <p class='bcode'>
+ * <ja>@RestMethod</ja>(name=<jsf>PUT</jsf>)
+ * <jk>public void</jk> doPut(<ja>@Body</ja>(format=<js>"/\\w+\\.\\d+/"</js>) String input) {...}
+ * </p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
* The format of the value is plain-text.
* <li>
+ * This string SHOULD be a valid regular expression.
+ * <li>
* Supports <a class="doclink" href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time and request-time variables</a>
* (e.g. <js>"$L{my.localized.variable}"</js>).
* </ul>
@@ -212,6 +297,12 @@ public @interface Body {
/**
* Defines the swagger value <code>/paths/{path}/{method}/parameters/#/collectionFormat</code>.
*
+ * <h5 class='section'>Example:</h5>
+ * <p class='bcode'>
+ * <ja>@RestMethod</ja>(name=<jsf>PUT</jsf>)
+ * <jk>public void</jk> doPut(<ja>@Body</ja>(type=<js>"array"</js>,collectionFormat=<js>"csv"</js>) String input) {...}
+ * </p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/FormData.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/FormData.java
index b646f9a..acd4540 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/FormData.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/FormData.java
@@ -150,6 +150,11 @@ public @interface FormData {
* Supports <a class="doclink" href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time and request-time variables</a>
* (e.g. <js>"$L{my.localized.variable}"</js>).
* </ul>
+ *
+ * <h5 class='section'>See Also:</h5>
+ * <ul class='doctree'>
+ * <li class='link'><a class='doclink' href='https://swagger.io/specification/#dataTypes'>Swagger specification > Data Types</a>
+ * </ul>
*/
String type() default "";
@@ -164,6 +169,11 @@ public @interface FormData {
* Supports <a class="doclink" href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time and request-time variables</a>
* (e.g. <js>"$L{my.localized.variable}"</js>).
* </ul>
+ *
+ * <h5 class='section'>See Also:</h5>
+ * <ul class='doctree'>
+ * <li class='link'><a class='doclink' href='https://swagger.io/specification/#dataTypes'>Swagger specification > Data Types</a>
+ * </ul>
*/
String format() default "";
@@ -175,6 +185,8 @@ public @interface FormData {
* <li>
* The format of the value is plain-text.
* <li>
+ * This string SHOULD be a valid regular expression.
+ * <li>
* Supports <a class="doclink" href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time and request-time variables</a>
* (e.g. <js>"$L{my.localized.variable}"</js>).
* </ul>
@@ -381,7 +393,8 @@ public @interface FormData {
/**
* Defines the swagger value <code>/paths/{path}/{method}/parameters/#/default</code>.
*
- * {@link TODO Also used to set a default value in the request}
+ * <p>
+ * Additionally, this method can be used to define a default value for a missing form data entry.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Header.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Header.java
index f5c6bb5..bd62089 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Header.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Header.java
@@ -123,6 +123,11 @@ public @interface Header {
* Supports <a class="doclink" href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time and request-time variables</a>
* (e.g. <js>"$L{my.localized.variable}"</js>).
* </ul>
+ *
+ * <h5 class='section'>See Also:</h5>
+ * <ul class='doctree'>
+ * <li class='link'><a class='doclink' href='https://swagger.io/specification/#dataTypes'>Swagger specification > Data Types</a>
+ * </ul>
*/
String type() default "";
@@ -137,6 +142,11 @@ public @interface Header {
* Supports <a class="doclink" href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time and request-time variables</a>
* (e.g. <js>"$L{my.localized.variable}"</js>).
* </ul>
+ *
+ * <h5 class='section'>See Also:</h5>
+ * <ul class='doctree'>
+ * <li class='link'><a class='doclink' href='https://swagger.io/specification/#dataTypes'>Swagger specification > Data Types</a>
+ * </ul>
*/
String format() default "";
@@ -148,6 +158,8 @@ public @interface Header {
* <li>
* The format of the value is plain-text.
* <li>
+ * This string SHOULD be a valid regular expression.
+ * <li>
* Supports <a class="doclink" href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time and request-time variables</a>
* (e.g. <js>"$L{my.localized.variable}"</js>).
* </ul>
@@ -354,7 +366,8 @@ public @interface Header {
/**
* Defines the swagger value <code>/paths/{path}/{method}/parameters/#/default</code>.
*
- * {@link TODO Also used to set a default value in the request}
+ * <p>
+ * Additionally, this method can be used to define a default value for a missing header entry.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/MethodSwagger.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/MethodSwagger.java
index 0878962..48b98e3 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/MethodSwagger.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/MethodSwagger.java
@@ -22,7 +22,6 @@ package org.apache.juneau.rest.annotation;
*/
public @interface MethodSwagger {
-
/**
* Swagger JSON.
*
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Path.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Path.java
index 3e4cdf6..b8c21a6 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Path.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Path.java
@@ -103,6 +103,11 @@ public @interface Path {
* Supports <a class="doclink" href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time and request-time variables</a>
* (e.g. <js>"$L{my.localized.variable}"</js>).
* </ul>
+ *
+ * <h5 class='section'>See Also:</h5>
+ * <ul class='doctree'>
+ * <li class='link'><a class='doclink' href='https://swagger.io/specification/#dataTypes'>Swagger specification > Data Types</a>
+ * </ul>
*/
String type() default "";
@@ -117,6 +122,11 @@ public @interface Path {
* Supports <a class="doclink" href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time and request-time variables</a>
* (e.g. <js>"$L{my.localized.variable}"</js>).
* </ul>
+ *
+ * <h5 class='section'>See Also:</h5>
+ * <ul class='doctree'>
+ * <li class='link'><a class='doclink' href='https://swagger.io/specification/#dataTypes'>Swagger specification > Data Types</a>
+ * </ul>
*/
String format() default "";
@@ -128,6 +138,8 @@ public @interface Path {
* <li>
* The format of the value is plain-text.
* <li>
+ * This string SHOULD be a valid regular expression.
+ * <li>
* Supports <a class="doclink" href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time and request-time variables</a>
* (e.g. <js>"$L{my.localized.variable}"</js>).
* </ul>
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Query.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Query.java
index 574bcbf..0e4ee84 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Query.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Query.java
@@ -146,6 +146,11 @@ public @interface Query {
* Supports <a class="doclink" href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time and request-time variables</a>
* (e.g. <js>"$L{my.localized.variable}"</js>).
* </ul>
+ *
+ * <h5 class='section'>See Also:</h5>
+ * <ul class='doctree'>
+ * <li class='link'><a class='doclink' href='https://swagger.io/specification/#dataTypes'>Swagger specification > Data Types</a>
+ * </ul>
*/
String type() default "";
@@ -160,6 +165,11 @@ public @interface Query {
* Supports <a class="doclink" href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time and request-time variables</a>
* (e.g. <js>"$L{my.localized.variable}"</js>).
* </ul>
+ *
+ * <h5 class='section'>See Also:</h5>
+ * <ul class='doctree'>
+ * <li class='link'><a class='doclink' href='https://swagger.io/specification/#dataTypes'>Swagger specification > Data Types</a>
+ * </ul>
*/
String format() default "";
@@ -171,6 +181,8 @@ public @interface Query {
* <li>
* The format of the value is plain-text.
* <li>
+ * This string SHOULD be a valid regular expression.
+ * <li>
* Supports <a class="doclink" href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time and request-time variables</a>
* (e.g. <js>"$L{my.localized.variable}"</js>).
* </ul>
@@ -377,7 +389,8 @@ public @interface Query {
/**
* Defines the swagger value <code>/paths/{path}/{method}/parameters/#/default</code>.
*
- * {@link TODO Also used to set a default value in the request}
+ * <p>
+ * Additionally, this method can be used to define a default value for a missing query entry.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/ResponseHeader.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/ResponseHeader.java
index b16296a..35bba7f 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/ResponseHeader.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/ResponseHeader.java
@@ -166,6 +166,11 @@ public @interface ResponseHeader {
* Supports <a class="doclink" href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time and request-time variables</a>
* (e.g. <js>"$L{my.localized.variable}"</js>).
* </ul>
+ *
+ * <h5 class='section'>See Also:</h5>
+ * <ul class='doctree'>
+ * <li class='link'><a class='doclink' href='https://swagger.io/specification/#dataTypes'>Swagger specification > Data Types</a>
+ * </ul>
*/
String type() default "";
@@ -180,6 +185,11 @@ public @interface ResponseHeader {
* Supports <a class="doclink" href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time and request-time variables</a>
* (e.g. <js>"$L{my.localized.variable}"</js>).
* </ul>
+ *
+ * <h5 class='section'>See Also:</h5>
+ * <ul class='doctree'>
+ * <li class='link'><a class='doclink' href='https://swagger.io/specification/#dataTypes'>Swagger specification > Data Types</a>
+ * </ul>
*/
String format() default "";
--
To stop receiving notification emails like this one, please contact
jamesbognar@apache.org.