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 6dd15fc Javadocs.
6dd15fc is described below
commit 6dd15fc85ab161d23853d783c3f27ef775c17545
Author: JamesBognar <[email protected]>
AuthorDate: Sun Jul 1 19:12:37 2018 -0400
Javadocs.
---
.../org/apache/juneau/http/annotation/Body.java | 3 +-
.../juneau/http/annotation/ExternalDocs.java | 1 -
.../apache/juneau/http/annotation/FormData.java | 1 -
.../org/apache/juneau/http/annotation/Header.java | 1 -
.../org/apache/juneau/http/annotation/Path.java | 1 -
.../org/apache/juneau/http/annotation/Query.java | 1 -
.../org/apache/juneau/http/annotation/Schema.java | 2 -
.../org/apache/juneau/httppart/HttpPartSchema.java | 616 +++++++++++++++------
8 files changed, 445 insertions(+), 181 deletions(-)
diff --git
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/Body.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/Body.java
index ca5e1a6..5beb1a9 100644
---
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/Body.java
+++
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/Body.java
@@ -269,7 +269,6 @@ public @interface Body {
* <li>
* The format is plain text.
* <br>Multiple lines are concatenated with newlines.
- * <br>TODO - Future support for <a
href='https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown'>MarkDown</a>.
* <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>).
@@ -563,7 +562,7 @@ public @interface Body {
String[] value() default {};
/**
- * TODO
+ * Equivalent to {@link #value()}.
*/
String[] api() default {};
diff --git
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/ExternalDocs.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/ExternalDocs.java
index cb60d6a..dcb2dc5 100644
---
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/ExternalDocs.java
+++
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/ExternalDocs.java
@@ -35,7 +35,6 @@ public @interface ExternalDocs {
* <li>
* The format is a plain-text string.
* <br>Multiple lines are concatenated with newlines.
- * <br>TODO - Future support for <a
href='https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown'>MarkDown</a>.
* <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>).
diff --git
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/FormData.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/FormData.java
index 5b55407..134b18c 100644
---
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/FormData.java
+++
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/FormData.java
@@ -332,7 +332,6 @@ public @interface FormData {
* <li>
* The format is plain text.
* <br>Multiple lines are concatenated with newlines.
- * <br>TODO - Future support for <a
href='https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown'>MarkDown</a>.
* <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>).
diff --git
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/Header.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/Header.java
index c83f827..04077d3 100644
---
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/Header.java
+++
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/Header.java
@@ -296,7 +296,6 @@ public @interface Header {
* <li>
* The format is plain text.
* <br>Multiple lines are concatenated with newlines.
- * <br>TODO - Future support for <a
href='https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown'>MarkDown</a>.
* <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>).
diff --git
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/Path.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/Path.java
index aed457e..22d5bdd 100644
---
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/Path.java
+++
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/Path.java
@@ -292,7 +292,6 @@ public @interface Path {
* <li>
* The format is plain text.
* <br>Multiple lines are concatenated with newlines.
- * <br>TODO - Future support for <a
href='https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown'>MarkDown</a>.
* <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>).
diff --git
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/Query.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/Query.java
index 1df1de7..2f2e972 100644
---
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/Query.java
+++
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/Query.java
@@ -328,7 +328,6 @@ public @interface Query {
* <li>
* The format is plain text.
* <br>Multiple lines are concatenated with newlines.
- * <br>TODO - Future support for <a
href='https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown'>MarkDown</a>.
* <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>).
diff --git
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/Schema.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/Schema.java
index e2f378e..d33ab89 100644
---
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/Schema.java
+++
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/Schema.java
@@ -129,8 +129,6 @@ public @interface Schema {
* <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>
- * TODO - Future support for MarkDown.
* </ul>
*/
String[] description() default {};
diff --git
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/HttpPartSchema.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/HttpPartSchema.java
index 1e8dbcc..3468687 100644
---
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/HttpPartSchema.java
+++
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/HttpPartSchema.java
@@ -732,7 +732,14 @@ public class HttpPartSchema {
}
/**
- * <mk>name</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
+ * <mk>name</mk> field.
+ *
+ * <p>
+ * Applicable to the following Swagger schema objects:
+ * <ul>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a>
+ * </ul>
*
* @param value
* The new value for this property.
@@ -745,7 +752,13 @@ public class HttpPartSchema {
}
/**
- * <mk>httpStatusCode</mk> key of the Swagger <a
class="doclink"
href="https://swagger.io/specification/v2/#responsesObject";>Responses</a>
object.
+ * <mk>httpStatusCode</mk> key.
+ *
+ * <p>
+ * Applicable to the following Swagger schema objects:
+ * <ul>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#responsesObject";>Responses</a>
+ * </ul>
*
* @param value
* The new value for this property.
@@ -760,7 +773,13 @@ public class HttpPartSchema {
}
/**
- * <mk>httpStatusCode</mk> key of the Swagger <a
class="doclink"
href="https://swagger.io/specification/v2/#responsesObject";>Responses</a>
object.
+ * <mk>httpStatusCode</mk> key.
+ *
+ * <p>
+ * Applicable to the following Swagger schema objects:
+ * <ul>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#responsesObject";>Responses</a>
+ * </ul>
*
* @param value
* The new value for this property.
@@ -777,11 +796,18 @@ public class HttpPartSchema {
}
/**
- * <mk>required</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
+ * <mk>required</mk> field.
*
* <p>
* Determines whether the parameter is mandatory.
*
+ * <p>
+ * Applicable to the following Swagger schema objects:
+ * <ul>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a>
+ * </ul>
+ *
* @param value
* The new value for this property.
* <br>Ignored if value is <jk>null</jk>.
@@ -794,7 +820,7 @@ public class HttpPartSchema {
}
/**
- * <mk>type</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
+ * <mk>type</mk> field.
*
* <p>
* The type of the parameter.
@@ -834,6 +860,15 @@ public class HttpPartSchema {
* <p>
* If the type is not specified, it will be auto-detected based
on the parameter class type.
*
+ * <p>
+ * Applicable to the following Swagger schema objects:
+ * <ul>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#securitySchemeObject";>Security
Scheme</a>
+ * </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>
@@ -855,7 +890,7 @@ public class HttpPartSchema {
}
/**
- * <mk>format</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
+ * <mk>format</mk> field.
*
* <p>
* The extending format for the previously mentioned <a
href='https://swagger.io/specification/v2/#parameterType'>type</a>.
@@ -898,6 +933,15 @@ public class HttpPartSchema {
* <br>If not specified, then the input is
interpreted as plain-text and is converted to a POJO directly.
* </ul>
*
+ * <p>
+ * Applicable to the following Swagger schema objects:
+ * <ul>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a>
+ * </ul>
+ *
* <h5 class='section'>See Also:</h5>
* <ul class='doctree'>
* <li class='link'><a class='doclink'
href='https://swagger.io/specification/v2/#dataTypeFormat'>Swagger
specification > Data Type Formats</a>
@@ -919,13 +963,19 @@ public class HttpPartSchema {
}
/**
- * <mk>allowEmptyValue</mk> field of the Swagger <a
class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
+ * <mk>allowEmptyValue</mk> field.
*
* <p>
* Sets the ability to pass empty-valued parameters.
* <br>This is valid only for either query or formData
parameters and allows you to send a parameter with a name only or an empty
value.
* <br>The default value is <jk>false</jk>.
*
+ * <p>
+ * Applicable to the following Swagger schema objects:
+ * <ul>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
+ * </ul>
+ *
* @param value
* The new value for this property.
* <br>Ignored if value is <jk>null</jk>.
@@ -938,7 +988,7 @@ public class HttpPartSchema {
}
/**
- * <mk>items</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
+ * <mk>items</mk> field.
*
* <p>
* Describes the type of items in the array.
@@ -946,12 +996,21 @@ public class HttpPartSchema {
* Required if <code>type</code> is <js>"array"</js>.
* <br>Can only be used if <code>type</code> is
<js>"array"</js>.
*
+ * <p>
+ * Applicable to the following Swagger schema objects:
+ * <ul>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a>
+ * </ul>
+ *
* @param value
* The new value for this property.
* <br>Ignored if value is <jk>null</jk> or empty.
* @return This object (for method chaining).
*/
- Builder items(ObjectMap value) {
+ public Builder items(ObjectMap value) {
if (value != null && ! value.isEmpty()) {
items = HttpPartSchema.create().apply(value);
api.put("items", value);
@@ -976,7 +1035,7 @@ public class HttpPartSchema {
}
/**
- * <mk>collectionFormat</mk> field of the Swagger <a
class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
+ * <mk>collectionFormat</mk> field.
*
* <p>
* Determines the format of the array if <code>type</code>
<js>"array"</js> is used.
@@ -1000,6 +1059,14 @@ public class HttpPartSchema {
* </ul>
*
* <p>
+ * Applicable to the following Swagger schema objects:
+ * <ul>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a>
+ * </ul>
+ *
+ * <p>
* Note that for collections/arrays parameters with POJO
element types, the input is broken into a string array before being converted
into POJO elements.
*
* @param value
@@ -1018,12 +1085,21 @@ public class HttpPartSchema {
}
/**
- * <mk>default</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
+ * <mk>default</mk> field.
*
* <p>
* Declares the value of the parameter that the server will use
if none is provided, for example a "count" to control the number of results per
page might default to 100 if not supplied by the client in the request.
* <br>(Note: "default" has no meaning for required parameters.)
*
+ * <p>
+ * Applicable to the following Swagger schema objects:
+ * <ul>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a>
+ * </ul>
+ *
* @param value
* The new value for this property.
* <br>Ignored if value is <jk>null</jk> or empty.
@@ -1036,7 +1112,7 @@ public class HttpPartSchema {
}
/**
- * <mk>maximum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
+ * <mk>maximum</mk> field.
*
* <p>
* Defines the maximum value for a parameter of numeric types.
@@ -1044,6 +1120,15 @@ public class HttpPartSchema {
* <p>
* Only allowed for the following types: <js>"integer"</js>,
<js>"number"</js>.
*
+ * <p>
+ * Applicable to the following Swagger schema objects:
+ * <ul>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a>
+ * </ul>
+ *
* @param value
* The new value for this property.
* <br>Ignored if value is <jk>null</jk>.
@@ -1056,7 +1141,7 @@ public class HttpPartSchema {
}
/**
- * <mk>exclusiveMaximum</mk> field of the Swagger <a
class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
+ * <mk>exclusiveMaximum</mk> field.
*
* <p>
* Defines whether the maximum is matched exclusively.
@@ -1065,6 +1150,15 @@ public class HttpPartSchema {
* Only allowed for the following types: <js>"integer"</js>,
<js>"number"</js>.
* <br>If <jk>true</jk>, must be accompanied with
<code>maximum</code>.
*
+ * <p>
+ * Applicable to the following Swagger schema objects:
+ * <ul>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a>
+ * </ul>
+ *
* @param value
* The new value for this property.
* <br>Ignored if value is <jk>null</jk>.
@@ -1077,7 +1171,7 @@ public class HttpPartSchema {
}
/**
- * <mk>minimum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
+ * <mk>minimum</mk> field.
*
* <p>
* Defines the minimum value for a parameter of numeric types.
@@ -1085,6 +1179,15 @@ public class HttpPartSchema {
* <p>
* Only allowed for the following types: <js>"integer"</js>,
<js>"number"</js>.
*
+ * <p>
+ * Applicable to the following Swagger schema objects:
+ * <ul>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a>
+ * </ul>
+ *
* @param value
* The new value for this property.
* <br>Ignored if value is <jk>null</jk>.
@@ -1097,7 +1200,7 @@ public class HttpPartSchema {
}
/**
- * <mk>exclusiveMinimum</mk> field of the Swagger <a
class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
+ * <mk>exclusiveMinimum</mk> field.
*
* <p>
* Defines whether the minimum is matched exclusively.
@@ -1106,6 +1209,15 @@ public class HttpPartSchema {
* Only allowed for the following types: <js>"integer"</js>,
<js>"number"</js>.
* <br>If <jk>true</jk>, must be accompanied with
<code>minimum</code>.
*
+ * <p>
+ * Applicable to the following Swagger schema objects:
+ * <ul>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a>
+ * </ul>
+ *
* @param value
* The new value for this property.
* <br>Ignored if value is <jk>null</jk>.
@@ -1118,7 +1230,7 @@ public class HttpPartSchema {
}
/**
- * <mk>maxLength</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
+ * <mk>maxLength</mk> field.
*
* <p>
* A string instance is valid against this keyword if its
length is less than, or equal to, the value of this keyword.
@@ -1127,6 +1239,15 @@ public class HttpPartSchema {
* <p>
* Only allowed for the following types: <js>"string"</js>.
*
+ * <p>
+ * Applicable to the following Swagger schema objects:
+ * <ul>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a>
+ * </ul>
+ *
* @param value
* The new value for this property.
* <br>Ignored if value is <jk>null</jk>.
@@ -1139,7 +1260,7 @@ public class HttpPartSchema {
}
/**
- * <mk>minLength</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
+ * <mk>minLength</mk> field.
*
* <p>
* A string instance is valid against this keyword if its
length is greater than, or equal to, the value of this keyword.
@@ -1148,6 +1269,15 @@ public class HttpPartSchema {
* <p>
* Only allowed for the following types: <js>"string"</js>.
*
+ * <p>
+ * Applicable to the following Swagger schema objects:
+ * <ul>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a>
+ * </ul>
+ *
* @param value
* The new value for this property.
* <br>Ignored if value is <jk>null</jk>.
@@ -1160,7 +1290,7 @@ public class HttpPartSchema {
}
/**
- * <mk>pattern</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
+ * <mk>pattern</mk> field.
*
* <p>
* A string input is valid if it matches the specified regular
expression pattern.
@@ -1168,6 +1298,15 @@ public class HttpPartSchema {
* <p>
* Only allowed for the following types: <js>"string"</js>.
*
+ * <p>
+ * Applicable to the following Swagger schema objects:
+ * <ul>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a>
+ * </ul>
+ *
* @param value
* The new value for this property.
* <br>Ignored if value is <jk>null</jk> or empty.
@@ -1184,7 +1323,7 @@ public class HttpPartSchema {
}
/**
- * <mk>maxItems</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
+ * <mk>maxItems</mk> field.
*
* <p>
* An array or collection is valid if its size is less than, or
equal to, the value of this keyword.
@@ -1192,6 +1331,15 @@ public class HttpPartSchema {
* <p>
* Only allowed for the following types: <js>"array"</js>.
*
+ * <p>
+ * Applicable to the following Swagger schema objects:
+ * <ul>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a>
+ * </ul>
+ *
* @param value
* The new value for this property.
* <br>Ignored if value is <jk>null</jk>.
@@ -1204,7 +1352,7 @@ public class HttpPartSchema {
}
/**
- * <mk>minItems</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
+ * <mk>minItems</mk> field.
*
* <p>
* An array or collection is valid if its size is greater than,
or equal to, the value of this keyword.
@@ -1212,6 +1360,15 @@ public class HttpPartSchema {
* <p>
* Only allowed for the following types: <js>"array"</js>.
*
+ * <p>
+ * Applicable to the following Swagger schema objects:
+ * <ul>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a>
+ * </ul>
+ *
* @param value
* The new value for this property.
* <br>Ignored if value is <jk>null</jk>.
@@ -1224,7 +1381,7 @@ public class HttpPartSchema {
}
/**
- * <mk>uniqueItems</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
+ * <mk>uniqueItems</mk> field.
*
* <p>
* If <jk>true</jk>, the input validates successfully if all of
its elements are unique.
@@ -1236,6 +1393,15 @@ public class HttpPartSchema {
* <p>
* Only allowed for the following types: <js>"array"</js>.
*
+ * <p>
+ * Applicable to the following Swagger schema objects:
+ * <ul>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a>
+ * </ul>
+ *
* @param value
* The new value for this property.
* <br>Ignored if value is <jk>null</jk>.
@@ -1262,11 +1428,20 @@ public class HttpPartSchema {
}
/**
- * <mk>enum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
+ * <mk>enum</mk> field.
*
* <p>
* If specified, the input validates successfully if it is
equal to one of the elements in this array.
*
+ * <p>
+ * Applicable to the following Swagger schema objects:
+ * <ul>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a>
+ * </ul>
+ *
* @param value
* The new value for this property.
* <br>Ignored if value is <jk>null</jk>.
@@ -1279,7 +1454,7 @@ public class HttpPartSchema {
}
/**
- * <mk>multipleOf</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
+ * <mk>multipleOf</mk> field.
*
* <p>
* A numeric instance is valid if the result of the division of
the instance by this keyword's value is an integer.
@@ -1287,6 +1462,15 @@ public class HttpPartSchema {
* <p>
* Only allowed for the following types: <js>"integer"</js>,
<js>"number"</js>.
*
+ * <p>
+ * Applicable to the following Swagger schema objects:
+ * <ul>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a>
+ * </ul>
+ *
* @param value
* The new value for this property.
* <br>Ignored if value is <jk>null</jk>.
@@ -1299,7 +1483,13 @@ public class HttpPartSchema {
}
/**
- * TODO
+ * <mk>mapProperties</mk> field.
+ *
+ * <p>
+ * Applicable to the following Swagger schema objects:
+ * <ul>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a>
+ * </ul>
*
* @param value
* The new value for this property.
@@ -1313,7 +1503,13 @@ public class HttpPartSchema {
}
/**
- * TODO
+ * <mk>minProperties</mk> field.
+ *
+ * <p>
+ * Applicable to the following Swagger schema objects:
+ * <ul>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a>
+ * </ul>
*
* @param value
* The new value for this property.
@@ -1327,7 +1523,13 @@ public class HttpPartSchema {
}
/**
- * TODO
+ * <mk>properties</mk> field.
+ *
+ * <p>
+ * Applicable to the following Swagger schema objects:
+ * <ul>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a>
+ * </ul>
*
* @param value
* The new value for this property.
@@ -1342,7 +1544,13 @@ public class HttpPartSchema {
}
/**
- * TODO
+ * <mk>additionalProperties</mk> field.
+ *
+ * <p>
+ * Applicable to the following Swagger schema objects:
+ * <ul>
+ * <li><a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a>
+ * </ul>
*
* @param value
* The new value for this property.
@@ -1370,7 +1578,7 @@ public class HttpPartSchema {
}
/**
- * TODO
+ * Identifies the part parser to use for parsing this part.
*
* @param value
* The new value for this property.
@@ -1384,8 +1592,9 @@ public class HttpPartSchema {
}
/**
- * TODO
- * @param noValidate
+ * Disables Swagger schema usage validation checking.
+ *
+ * @param noValidate Specify <jk>true</jk> to prevent {@link
ContextRuntimeException} from being thrown if invalid Swagger usage was
detected.
* @return This object (for method chaining).
*/
public Builder noValidate(boolean noValidate) {
@@ -1589,6 +1798,7 @@ public class HttpPartSchema {
* Returns the name of the object described by this schema, for example
the query or form parameter name.
*
* @return The name, or <jk>null</jk> if not specified.
+ * @see Builder#name(String)
*/
public String getName() {
return name;
@@ -1600,6 +1810,8 @@ public class HttpPartSchema {
* @return
* The list of HTTP status codes.
* <br>Never <jk>null</jk>.
+ * @see Builder#code(int)
+ * @see Builder#codes(int[])
*/
public Set<Integer> getCodes() {
return codes;
@@ -1613,6 +1825,8 @@ public class HttpPartSchema {
* The list of HTTP status codes.
* <br>A singleton set containing the default value if the set is
empty.
* <br>Never <jk>null</jk>.
+ * @see Builder#code(int)
+ * @see Builder#codes(int[])
*/
public Set<Integer> getCodes(Integer def) {
return codes.isEmpty() ? Collections.singleton(def) : codes;
@@ -1626,24 +1840,28 @@ public class HttpPartSchema {
* The list of HTTP status codes.
* <br>A singleton set containing the default value if the set is
empty.
* <br>Never <jk>null</jk>.
+ * @see Builder#code(int)
+ * @see Builder#codes(int[])
*/
public Integer getCode(Integer def) {
return codes.isEmpty() ? def : codes.iterator().next();
}
/**
- * TODO
+ * Returns the <code>type</code> field of this schema.
*
- * @return TODO
+ * @return The <code>type</code> field of this schema, or <jk>null</jk>
if not specified.
+ * @see Builder#type(String)
*/
public Type getType() {
return type;
}
/**
- * Returns the default value for this schema.
+ * Returns the <code>default</code> field of this schema.
*
* @return The default value for this schema, or <jk>null</jk> if not
specified.
+ * @see Builder#_default(String)
*/
public String getDefault() {
return _default;
@@ -1652,19 +1870,21 @@ public class HttpPartSchema {
/**
* Returns the <code>collectionFormat</code> field of this schema.
*
- * @return The <code>collectionFormat</code> field of this schema.
+ * @return The <code>collectionFormat</code> field of this schema, or
<jk>null</jk> if not specified.
+ * @see Builder#collectionFormat(String)
*/
public CollectionFormat getCollectionFormat() {
return collectionFormat;
}
/**
- * Returns the type field of this schema.
+ * Returns the <code>type</code> field of this schema.
*
* @param cm
* The class meta of the object.
* <br>Used to auto-detect the type if the type was not specified.
- * @return The format field of this schema.
+ * @return The format field of this schema, or <jk>null</jk> if not
specified.
+ * @see Builder#format(String)
*/
public Type getType(ClassMeta<?> cm) {
if (type != Type.NONE)
@@ -1685,24 +1905,208 @@ public class HttpPartSchema {
/**
* Returns the <code>format</code> field of this schema.
*
- * @return The <code>format</code> field of this schema.
+ * @return The <code>format</code> field of this schema, or
<jk>null</jk> if not specified.
+ * @see Builder#format(String)
*/
public Format getFormat() {
return format;
}
/**
- * Returns the schema for child items of the object represented by this
schema.
+ * Returns the <code>maximum</code> field of this schema.
*
* @return The schema for child items of the object represented by this
schema, or <jk>null</jk> if not defined.
+ * @see Builder#items(ObjectMap)
*/
public HttpPartSchema getItems() {
return items;
}
/**
- * TODO
- * @return TODO
+ * Returns the <code>maximum</code> field of this schema.
+ *
+ * @return The <code>maximum</code> field of this schema, or
<jk>null</jk> if not specified.
+ * @see Builder#maximum(Number)
+ */
+ public Number getMaximum() {
+ return maximum;
+ }
+
+ /**
+ * Returns the <code>minimum</code> field of this schema.
+ *
+ * @return The <code>minimum</code> field of this schema, or
<jk>null</jk> if not specified.
+ * @see Builder#minimum(Number)
+ */
+ public Number getMinimum() {
+ return minimum;
+ }
+
+ /**
+ * Returns the <code>xxx</code> field of this schema.
+ *
+ * @return The <code>xxx</code> field of this schema, or <jk>null</jk>
if not specified.
+ * @see Builder#multipleOf(Number)
+ */
+ public Number getMultipleOf() {
+ return multipleOf;
+ }
+
+ /**
+ * Returns the <code>xxx</code> field of this schema.
+ *
+ * @return The <code>xxx</code> field of this schema, or <jk>null</jk>
if not specified.
+ * @see Builder#pattern(String)
+ */
+ public Pattern getPattern() {
+ return pattern;
+ }
+
+ /**
+ * Returns the <code>xxx</code> field of this schema.
+ *
+ * @return The <code>xxx</code> field of this schema, or <jk>null</jk>
if not specified.
+ * @see Builder#maxLength(Long)
+ */
+ public Long getMaxLength() {
+ return maxLength;
+ }
+
+ /**
+ * Returns the <code>xxx</code> field of this schema.
+ *
+ * @return The <code>xxx</code> field of this schema, or <jk>null</jk>
if not specified.
+ * @see Builder#minLength(Long)
+ */
+ public Long getMinLength() {
+ return minLength;
+ }
+
+ /**
+ * Returns the <code>xxx</code> field of this schema.
+ *
+ * @return The <code>xxx</code> field of this schema, or <jk>null</jk>
if not specified.
+ * @see Builder#maxItems(Long)
+ */
+ public Long getMaxItems() {
+ return maxItems;
+ }
+
+ /**
+ * Returns the <code>xxx</code> field of this schema.
+ *
+ * @return The <code>xxx</code> field of this schema, or <jk>null</jk>
if not specified.
+ * @see Builder#minItems(Long)
+ */
+ public Long getMinItems() {
+ return minItems;
+ }
+
+ /**
+ * Returns the <code>xxx</code> field of this schema.
+ *
+ * @return The <code>xxx</code> field of this schema, or <jk>null</jk>
if not specified.
+ * @see Builder#maxProperties(Long)
+ */
+ public Long getMaxProperties() {
+ return maxProperties;
+ }
+
+ /**
+ * Returns the <code>xxx</code> field of this schema.
+ *
+ * @return The <code>xxx</code> field of this schema, or <jk>null</jk>
if not specified.
+ * @see Builder#minProperties(Long)
+ */
+ public Long getMinProperties() {
+ return minProperties;
+ }
+
+ /**
+ * Returns the <code>exclusiveMaximum</code> field of this schema.
+ *
+ * @return The <code>exclusiveMaximum</code> field of this schema, or
<jk>null</jk> if not specified.
+ * @see Builder#exclusiveMaximum(Boolean)
+ */
+ public Boolean getExclusiveMaximum() {
+ return exclusiveMaximum;
+ }
+
+ /**
+ * Returns the <code>exclusiveMinimum</code> field of this schema.
+ *
+ * @return The <code>exclusiveMinimum</code> field of this schema, or
<jk>null</jk> if not specified.
+ * @see Builder#exclusiveMinimum(Boolean)
+ */
+ public Boolean getExclusiveMinimum() {
+ return exclusiveMinimum;
+ }
+
+ /**
+ * Returns the <code>uniqueItems</code> field of this schema.
+ *
+ * @return The <code>uniqueItems</code> field of this schema, or
<jk>null</jk> if not specified.
+ * @see Builder#uniqueItems(Boolean)
+ */
+ public Boolean getUniqueItems() {
+ return uniqueItems;
+ }
+
+ /**
+ * Returns the <code>required</code> field of this schema.
+ *
+ * @return The <code>required</code> field of this schema, or
<jk>null</jk> if not specified.
+ * @see Builder#required(Boolean)
+ */
+ public Boolean getRequired() {
+ return required;
+ }
+
+ /**
+ * Returns the <code>skipIfEmpty</code> field of this schema.
+ *
+ * @return The <code>skipIfEmpty</code> field of this schema, or
<jk>null</jk> if not specified.
+ * @see Builder#skipIfEmpty(Boolean)
+ */
+ public Boolean getSkipIfEmpty() {
+ return skipIfEmpty;
+ }
+
+ /**
+ * Returns the <code>enum</code> field of this schema.
+ *
+ * @return The <code>enum</code> field of this schema, or <jk>null</jk>
if not specified.
+ * @see Builder#_enum(Set)
+ */
+ public Set<String> getEnum() {
+ return _enum;
+ }
+
+ /**
+ * Returns the <code>parser</code> field of this schema.
+ *
+ * @return The <code>parser</code> field of this schema, or
<jk>null</jk> if not specified.
+ * @see Builder#parser(Class)
+ */
+ public Class<? extends HttpPartParser> getParser() {
+ return parser;
+ }
+
+ /**
+ * Returns the <code>serializer</code> field of this schema.
+ *
+ * @return The <code>serializer</code> field of this schema, or
<jk>null</jk> if not specified.
+ * @see Builder#serializer(Class)
+ */
+ public Class<? extends HttpPartSerializer> getSerializer() {
+ return serializer;
+ }
+
+
+ /**
+ * Returns the Swagger documentation for this schema.
+ *
+ * @return The Swagger documentation for this schema as an unmodifiable
{@link ObjectMap}.
*/
public ObjectMap getApi() {
return api;
@@ -2027,136 +2431,4 @@ public class HttpPartSchema {
throw new RuntimeException(e);
}
}
-
- /**
- * TODO
- * @return TODO
- */
- public Number getMaximum() {
- return maximum;
- }
-
- /**
- * TODO
- * @return TODO
- */
- public Number getMinimum() {
- return minimum;
- }
-
- /**
- * TODO
- * @return TODO
- */
- public Number getMultipleOf() {
- return multipleOf;
- }
-
- /**
- * TODO
- * @return TODO
- */
- public Pattern getPattern() {
- return pattern;
- }
-
- /**
- * TODO
- * @return TODO
- */
- public Long getMaxLength() {
- return maxLength;
- }
-
- /**
- * TODO
- * @return TODO
- */
- public Long getMinLength() {
- return minLength;
- }
- /**
- * TODO
- * @return TODO
- */
- public Long getMaxItems() {
- return maxItems;
- }
- /**
- * TODO
- * @return TODO
- */
- public Long getMinItems() {
- return minItems;
- }
- /**
- * TODO
- * @return TODO
- */
- public Long getMaxProperties() {
- return maxProperties;
- }
- /**
- * TODO
- * @return TODO
- */
- public Long getMinProperties() {
- return minProperties;
- }
- /**
- * TODO
- * @return TODO
- */
- public Boolean getExclusiveMaximum() {
- return exclusiveMaximum;
- }
- /**
- * TODO
- * @return TODO
- */
- public Boolean getExclusiveMinimum() {
- return exclusiveMinimum;
- }
- /**
- * TODO
- * @return TODO
- */
- public Boolean getUniqueItems() {
- return uniqueItems;
- }
- /**
- * TODO
- * @return TODO
- */
- public Boolean getRequired() {
- return required;
- }
- /**
- * TODO
- * @return TODO
- */
- public Boolean getSkipIfEmpty() {
- return skipIfEmpty;
- }
- /**
- * TODO
- * @return TODO
- */
- public Set<String> getEnum() {
- return _enum;
- }
- /**
- * TODO
- * @return TODO
- */
- public Class<? extends HttpPartParser> getParser() {
- return parser;
- }
- /**
- * TODO
- * @return TODO
- */
- public Class<? extends HttpPartSerializer> getSerializer() {
- return serializer;
- }
}
