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 d94609f Javadocs.
d94609f is described below
commit d94609f17fe89ec6315f8cf7d810b2ba3801ff01
Author: JamesBognar <[email protected]>
AuthorDate: Sun Sep 8 10:53:45 2019 -0400
Javadocs.
---
.../org/apache/juneau/http/annotation/Body.java | 12 +--
.../org/apache/juneau/http/annotation/Contact.java | 2 +-
.../apache/juneau/http/annotation/FormData.java | 6 +-
.../org/apache/juneau/http/annotation/Header.java | 6 +-
.../org/apache/juneau/http/annotation/License.java | 2 +-
.../org/apache/juneau/http/annotation/Path.java | 8 +-
.../org/apache/juneau/http/annotation/Query.java | 8 +-
.../apache/juneau/http/annotation/Response.java | 12 +--
.../juneau/http/annotation/ResponseHeader.java | 4 +-
.../org/apache/juneau/http/annotation/Tag.java | 8 +-
.../apache/juneau/json/SimpleJsonSerializer.java | 2 +-
.../juneau/jsonschema/annotation/ExternalDocs.java | 4 +-
.../apache/juneau/jsonschema/annotation/Items.java | 4 +-
.../juneau/jsonschema/annotation/Schema.java | 30 +++---
.../juneau/jsonschema/annotation/SubItems.java | 6 +-
.../juneau/rest/annotation/MethodSwagger.java | 14 +--
.../juneau/rest/annotation/ResourceSwagger.java | 16 +--
.../apache/juneau/rest/annotation/RestMethod.java | 2 +-
.../juneau/rest/annotation/RestResource.java | 114 ++++++++++++++++++++-
19 files changed, 186 insertions(+), 74 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 47858fa..040502d 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
@@ -265,7 +265,7 @@ public @interface Body {
* A serialized example of the body of a request.
*
* <p>
- * This is the {@doc juneau-marshall.JsonDetails.SimplifiedJson} of an
example of the body.
+ * This is the {@doc SimpleJson} of an example of the body.
*
* <p>
* This value is converted to a POJO and then serialized to all the
registered serializers on the REST method to produce examples for all
@@ -370,7 +370,7 @@ public @interface Body {
*
* <ul class='notes'>
* <li>
- * The format is any {@doc
juneau-marshall.JsonDetails.SimplifiedJson} if the object can be converted to a
POJO using {@link JsonParser#DEFAULT} or a simple String if the object
+ * The format is any {@doc SimpleJson} if the object can
be converted to a POJO using {@link JsonParser#DEFAULT} or a simple String if
the object
* has a schema associated with it meancan be converted
from a String.
* <br>Multiple lines are concatenated with newlines.
* <li>
@@ -386,7 +386,7 @@ public @interface Body {
* Serialized examples of the body of a request.
*
* <p>
- * This is a {@doc juneau-marshall.JsonDetails.SimplifiedJson} object
whose keys are media types and values are string representations of that value.
+ * This is a {@doc SimpleJson} object whose keys are media types and
values are string representations of that value.
*
* <p>
* In general you won't need to populate this value directly since it
will automatically be calculated based on the value provided in the {@link
#example()} field.
@@ -410,7 +410,7 @@ public @interface Body {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object with string keys (media
type) and string values (example for that media type) .
+ * The format is a {@doc SimpleJson} object with string
keys (media type) and string values (example for that media type) .
* <li>
* The leading/trailing <c>{ }</c> characters are optional.
* <li>
@@ -429,7 +429,7 @@ public @interface Body {
* Free-form value for the {@doc SwaggerParameterObject}.
*
* <p>
- * This is a {@doc juneau-marshall.JsonDetails.SimplifiedJson} object
that makes up the swagger information for this parameter-info.
+ * This is a {@doc SimpleJson} object that makes up the swagger
information for this parameter-info.
*
* <p>
* The following are completely equivalent ways of defining the swagger
description of the body:
@@ -482,7 +482,7 @@ public @interface Body {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object.
+ * The format is a {@doc SimpleJson} object.
* <li>
* Schema-based serialization is NOT affected by values
defined in this annotation.
* <br>It only affects the generated Swagger documentation.
diff --git
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/Contact.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/Contact.java
index 85041b9..8835243 100644
---
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/Contact.java
+++
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/Contact.java
@@ -162,7 +162,7 @@ public @interface Contact {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object.
+ * The format is a {@doc SimpleJson} object.
* <li>
* The leading/trailing <c>{ }</c> characters are optional.
* <br>The following two example are considered equivalent:
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 ccf3634..955d191 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
@@ -808,7 +808,7 @@ public @interface FormData {
* <br>On the server-side, this gets converted to a <c>BadRequest</c>
(400).
*
* <p>
- * The format is a {@doc juneau-marshall.JsonDetails.SimplifiedJson}
array or comma-delimited list.
+ * The format is a {@doc SimpleJson} array or comma-delimited list.
* <br>Multiple lines are concatenated with newlines.
*
* <h5 class='section'>Examples:</h5>
@@ -917,7 +917,7 @@ public @interface FormData {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object or plain text string.
+ * The format is a {@doc SimpleJson} object or plain text
string.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports {@doc DefaultRestSvlVariables}
@@ -983,7 +983,7 @@ public @interface FormData {
* <li>
* Automatic validation is NOT performed on input based on
attributes in this value.
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object.
+ * The format is a {@doc SimpleJson} object.
* <li>
* The leading/trailing <c>{ }</c> characters are optional.
* <br>The following two example are considered equivalent:
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 0cf5155..5523b3b 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
@@ -773,7 +773,7 @@ public @interface Header {
* <br>On the server-side, this gets converted to a <c>BadRequest</c>
(400).
*
* <p>
- * The format is a {@doc juneau-marshall.JsonDetails.SimplifiedJson}
array or comma-delimited list.
+ * The format is a {@doc SimpleJson} array or comma-delimited list.
* <br>Multiple lines are concatenated with newlines.
*
* <h5 class='section'>Examples:</h5>
@@ -883,7 +883,7 @@ public @interface Header {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object or plain text string.
+ * The format is a {@doc SimpleJson} object or plain text
string.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports {@doc DefaultRestSvlVariables}
@@ -949,7 +949,7 @@ public @interface Header {
* <li>
* Note that the only swagger field you can't specify
using this value is <js>"name"</js> whose value needs to be known during
servlet initialization.
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object.
+ * The format is a {@doc SimpleJson} object.
* <li>
* Automatic validation is NOT performed on input based on
attributes in this value.
* <li>
diff --git
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/License.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/License.java
index 7e92544..fb9650e 100644
---
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/License.java
+++
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/License.java
@@ -134,7 +134,7 @@ public @interface License {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object.
+ * The format is a {@doc SimpleJson} object.
* <li>
* The leading/trailing <c>{ }</c> characters are optional.
* <br>The following two example are considered equivalent:
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 c0b75ee..2dc8a50 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
@@ -711,7 +711,7 @@ public @interface Path {
* <br>On the server-side, this gets converted to a <c>BadRequest</c>
(400).
*
* <p>
- * The format is a {@doc juneau-marshall.JsonDetails.SimplifiedJson}
array or comma-delimited list.
+ * The format is a {@doc SimpleJson} array or comma-delimited list.
* <br>Multiple lines are concatenated with newlines.
*
* <h5 class='section'>Examples:</h5>
@@ -823,7 +823,7 @@ public @interface Path {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object or plain text string.
+ * The format is a {@doc SimpleJson} object or plain text
string.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports {@doc DefaultRestSvlVariables}
@@ -836,7 +836,7 @@ public @interface Path {
* Free-form value for the {@doc SwaggerParameterObject}.
*
* <p>
- * This is a {@doc juneau-marshall.JsonDetails.SimplifiedJson} object
that makes up the swagger information for this field.
+ * This is a {@doc SimpleJson} object that makes up the swagger
information for this field.
*
* <p>
* The following are completely equivalent ways of defining the swagger
description of the Path object:
@@ -891,7 +891,7 @@ public @interface Path {
* <li>
* Note that the only swagger field you can't specify
using this value is <js>"name"</js> whose value needs to be known during
servlet initialization.
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object.
+ * The format is a {@doc SimpleJson} object.
* <li>
* Automatic validation is NOT performed on input based on
attributes in this value.
* <li>
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 591fb07..45b8921 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
@@ -786,7 +786,7 @@ public @interface Query {
* <br>On the server-side, this gets converted to a <c>BadRequest</c>
(400).
*
* <p>
- * The format is a {@doc juneau-marshall.JsonDetails.SimplifiedJson}
array or comma-delimited list.
+ * The format is a {@doc SimpleJson} array or comma-delimited list.
* <br>Multiple lines are concatenated with newlines.
*
* <h5 class='section'>Examples:</h5>
@@ -896,7 +896,7 @@ public @interface Query {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object or plain text string.
+ * The format is a {@doc SimpleJson} object or plain text
string.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports {@doc DefaultRestSvlVariables}
@@ -909,7 +909,7 @@ public @interface Query {
* Free-form value for the {@doc SwaggerParameterObject}.
*
* <p>
- * This is a {@doc juneau-marshall.JsonDetails.SimplifiedJson} object
that makes up the swagger information for this field.
+ * This is a {@doc SimpleJson} object that makes up the swagger
information for this field.
*
* <p>
* The following are completely equivalent ways of defining the swagger
description of the Query object:
@@ -976,7 +976,7 @@ public @interface Query {
* <li>
* Automatic validation is NOT performed on input based on
attributes in this value.
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object.
+ * The format is a {@doc SimpleJson} object.
* <li>
* The leading/trailing <c>{ }</c> characters are optional.
* <br>The following two example are considered equivalent:
diff --git
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/Response.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/Response.java
index 6d176d5..41f9550 100644
---
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/Response.java
+++
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/Response.java
@@ -145,7 +145,7 @@ public @interface Response {
* A serialized example of the body of a response.
*
* <p>
- * This is the {@doc juneau-marshall.JsonDetails.SimplifiedJson} of an
example of the body.
+ * This is the {@doc SimpleJson} of an example of the body.
*
* <p>
* This value is converted to a POJO and then serialized to all the
registered serializers on the REST method to produce examples for all
@@ -248,7 +248,7 @@ public @interface Response {
*
* <ul class='notes'>
* <li>
- * The format is any {@doc
juneau-marshall.JsonDetails.SimplifiedJson} if the object can be converted to a
POJO using {@link JsonParser#DEFAULT} or a simple String if the object
+ * The format is any {@doc SimpleJson} if the object can
be converted to a POJO using {@link JsonParser#DEFAULT} or a simple String if
the object
* has a schema associated with it meancan be converted
from a String.
* <br>Multiple lines are concatenated with newlines.
* <li>
@@ -264,7 +264,7 @@ public @interface Response {
* Serialized examples of the body of a response.
*
* <p>
- * This is a {@doc juneau-marshall.JsonDetails.SimplifiedJson} object
whose keys are media types and values are string representations of that value.
+ * This is a {@doc SimpleJson} object whose keys are media types and
values are string representations of that value.
*
* <p>
* In general you won't need to populate this value directly since it
will automatically be calculated based on the value provided in the {@link
#example()} field.
@@ -288,7 +288,7 @@ public @interface Response {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object with string keys (media
type) and string values (example for that media type) .
+ * The format is a {@doc SimpleJson} object with string
keys (media type) and string values (example for that media type) .
* <li>
* The leading/trailing <c>{ }</c> characters are optional.
* <li>
@@ -307,7 +307,7 @@ public @interface Response {
* Free-form value for the {@doc SwaggerResponseObject}.
*
* <p>
- * This is a {@doc juneau-marshall.JsonDetails.SimplifiedJson} object
that makes up the swagger information for this field.
+ * This is a {@doc SimpleJson} object that makes up the swagger
information for this field.
*
* <p>
* The following are completely equivalent ways of defining the swagger
description of the Response object:
@@ -369,7 +369,7 @@ public @interface Response {
* <li>
* Note that the only swagger field you can't specify
using this value is <js>"code"</js> whose value needs to be known during
servlet initialization.
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object.
+ * The format is a {@doc SimpleJson} object.
* <li>
* The leading/trailing <c>{ }</c> characters are optional.
* <br>The following two example are considered equivalent:
diff --git
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/ResponseHeader.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/ResponseHeader.java
index 0803bbd..73d0c12 100644
---
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/ResponseHeader.java
+++
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/ResponseHeader.java
@@ -533,7 +533,7 @@ public @interface ResponseHeader {
* Free-form value for the {@doc SwaggerHeaderObject}.
*
* <p>
- * This is a {@doc juneau-marshall.JsonDetails.SimplifiedJson} object
that makes up the swagger information for this field.
+ * This is a {@doc SimpleJson} object that makes up the swagger
information for this field.
*
* <p>
* The following are completely equivalent ways of defining the swagger
description of the Header object:
@@ -586,7 +586,7 @@ public @interface ResponseHeader {
* <li>
* Note that the only swagger field you can't specify
using this value is <js>"name"</js> whose value needs to be known during
servlet initialization.
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object.
+ * The format is a {@doc SimpleJson} object.
* <li>
* The leading/trailing <c>{ }</c> characters are optional.
* <br>The following two example are considered equivalent:
diff --git
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/Tag.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/Tag.java
index 93805c7..8a3207a 100644
---
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/Tag.java
+++
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/Tag.java
@@ -80,7 +80,7 @@ public @interface Tag {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object.
+ * The format is a {@doc SimpleJson} object.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports {@doc DefaultRestSvlVariables}
@@ -94,7 +94,7 @@ public @interface Tag {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object.
+ * The format is a {@doc SimpleJson} object.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports {@doc DefaultRestSvlVariables}
@@ -107,7 +107,7 @@ public @interface Tag {
* Free-form value for the {@doc SwaggerTagObject}.
*
* <p>
- * This is a {@doc juneau-marshall.JsonDetails.SimplifiedJson} object
that makes up the swagger information for this Tag object.
+ * This is a {@doc SimpleJson} object that makes up the swagger
information for this Tag object.
*
* <p>
* The following are completely equivalent ways of defining the swagger
description of the resource tags:
@@ -169,7 +169,7 @@ public @interface Tag {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object.
+ * The format is a {@doc SimpleJson} object.
* <li>
* The leading/trailing <c>{ }</c> characters are optional.
* <br>The following two example are considered equivalent:
diff --git
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/SimpleJsonSerializer.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/SimpleJsonSerializer.java
index 7fae549..6caa968 100644
---
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/SimpleJsonSerializer.java
+++
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/SimpleJsonSerializer.java
@@ -32,7 +32,7 @@ import org.apache.juneau.*;
* </ul>
*
* <ul class='seealso'>
- * <li class='link'>{@doc juneau-marshall.JsonDetails.SimplifiedJson}
+ * <li class='link'>{@doc SimpleJson}
* </ul>
*/
public class SimpleJsonSerializer extends JsonSerializer {
diff --git
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jsonschema/annotation/ExternalDocs.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jsonschema/annotation/ExternalDocs.java
index 5430fd3..f43fb7e 100644
---
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jsonschema/annotation/ExternalDocs.java
+++
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jsonschema/annotation/ExternalDocs.java
@@ -97,7 +97,7 @@ public @interface ExternalDocs {
* Free-form value for the {@doc SwaggerExternalDocumentationObject}.
*
* <p>
- * This is a {@doc juneau-marshall.JsonDetails.SimplifiedJson} object
that makes up the swagger information for this field.
+ * This is a {@doc SimpleJson} object that makes up the swagger
information for this field.
*
* <p>
* The following are completely equivalent ways of defining the swagger
description of documentation:
@@ -145,7 +145,7 @@ public @interface ExternalDocs {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object.
+ * The format is a {@doc SimpleJson} object.
* <li>
* The leading/trailing <c>{ }</c> characters are optional.
* <br>The following two example are considered equivalent:
diff --git
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jsonschema/annotation/Items.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jsonschema/annotation/Items.java
index 03c453d..dab267e 100644
---
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jsonschema/annotation/Items.java
+++
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jsonschema/annotation/Items.java
@@ -314,7 +314,7 @@ public @interface Items {
* Free-form value for the {@doc SwaggerItemsObject}.
*
* <p>
- * This is a {@doc juneau-marshall.JsonDetails.SimplifiedJson} object
that makes up the swagger information for this field.
+ * This is a {@doc SimpleJson} object that makes up the swagger
information for this field.
*
* <p>
* The following are completely equivalent ways of defining the swagger
description of an Items object:
@@ -380,7 +380,7 @@ public @interface Items {
* <li>
* Note that the only swagger field you can't specify
using this value is <js>"name"</js> whose value needs to be known during
servlet initialization.
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object.
+ * The format is a {@doc SimpleJson} object.
* <li>
* The leading/trailing <c>{ }</c> characters are optional.
* <br>The following two example are considered equivalent:
diff --git
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jsonschema/annotation/Schema.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jsonschema/annotation/Schema.java
index b91fd42..b219d4f 100644
---
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jsonschema/annotation/Schema.java
+++
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jsonschema/annotation/Schema.java
@@ -171,7 +171,7 @@ public @interface Schema {
*
* <ul class='notes'>
* <li>
- * The format is any {@doc
juneau-marshall.JsonDetails.SimplifiedJson}.
+ * The format is any {@doc SimpleJson}.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports {@doc DefaultRestSvlVariables}
@@ -337,7 +337,7 @@ public @interface Schema {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object.
+ * The format is a {@doc SimpleJson} object.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports {@doc DefaultRestSvlVariables}
@@ -352,7 +352,7 @@ public @interface Schema {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object.
+ * The format is a {@doc SimpleJson} object.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports {@doc DefaultRestSvlVariables}
@@ -400,7 +400,7 @@ public @interface Schema {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} array or comma-delimited list.
+ * The format is a {@doc SimpleJson} array or
comma-delimited list.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports {@doc DefaultRestSvlVariables}
@@ -460,7 +460,7 @@ public @interface Schema {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object.
+ * The format is a {@doc SimpleJson} object.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports {@doc DefaultRestSvlVariables}
@@ -519,7 +519,7 @@ public @interface Schema {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object.
+ * The format is a {@doc SimpleJson} object.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports {@doc DefaultRestSvlVariables}
@@ -533,7 +533,7 @@ public @interface Schema {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object.
+ * The format is a {@doc SimpleJson} object.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports {@doc DefaultRestSvlVariables}
@@ -547,7 +547,7 @@ public @interface Schema {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object.
+ * The format is a {@doc SimpleJson} object.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports {@doc DefaultRestSvlVariables}
@@ -561,7 +561,7 @@ public @interface Schema {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object.
+ * The format is a {@doc SimpleJson} object.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports {@doc DefaultRestSvlVariables}
@@ -575,7 +575,7 @@ public @interface Schema {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object.
+ * The format is a {@doc SimpleJson} object.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports {@doc DefaultRestSvlVariables}
@@ -589,7 +589,7 @@ public @interface Schema {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object.
+ * The format is a {@doc SimpleJson} object.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports {@doc DefaultRestSvlVariables}
@@ -603,7 +603,7 @@ public @interface Schema {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object.
+ * The format is a {@doc SimpleJson} object.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports {@doc DefaultRestSvlVariables}
@@ -624,7 +624,7 @@ public @interface Schema {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object or plain text string.
+ * The format is a {@doc SimpleJson} object or plain text
string.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports {@doc DefaultRestSvlVariables}
@@ -641,7 +641,7 @@ public @interface Schema {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object.
+ * The format is a {@doc SimpleJson} object.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports {@doc DefaultRestSvlVariables}
@@ -699,7 +699,7 @@ public @interface Schema {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object.
+ * The format is a {@doc SimpleJson} object.
* <li>
* The leading/trailing <c>{ }</c> characters are optional.
* <br>The following two example are considered equivalent:
diff --git
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jsonschema/annotation/SubItems.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jsonschema/annotation/SubItems.java
index aa4fef4..f2c91f8 100644
---
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jsonschema/annotation/SubItems.java
+++
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jsonschema/annotation/SubItems.java
@@ -263,7 +263,7 @@ public @interface SubItems {
* Describes the type of items in the array.
*
* <p>
- * This is a {@doc juneau-marshall.JsonDetails.SimplifiedJson} object.
+ * This is a {@doc SimpleJson} object.
* <br>It must be declared free-form because it's not possible to nest
annotations in Java.
*/
String[] items() default {};
@@ -272,7 +272,7 @@ public @interface SubItems {
* Free-form value for the {@doc SwaggerItemsObject}.
*
* <p>
- * This is a {@doc juneau-marshall.JsonDetails.SimplifiedJson} object
that makes up the swagger information for this field.
+ * This is a {@doc SimpleJson} object that makes up the swagger
information for this field.
*
* <p>
* The following are completely equivalent ways of defining the swagger
description of an Items object:
@@ -338,7 +338,7 @@ public @interface SubItems {
* <li>
* Note that the only swagger field you can't specify
using this value is <js>"name"</js> whose value needs to be known during
servlet initialization.
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object.
+ * The format is a {@doc SimpleJson} object.
* <li>
* The leading/trailing <c>{ }</c> characters are optional.
* <br>The following two example are considered equivalent:
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 f4da61a..7df1274 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
@@ -81,7 +81,7 @@ public @interface MethodSwagger {
*
* <ul class='notes'>
* <li>
- * The format is either a comma-delimited list of simple
strings or a {@doc juneau-marshall.JsonDetails.SimplifiedJson} array.
+ * The format is either a comma-delimited list of simple
strings or a {@doc SimpleJson} array.
* <li>
* Supports {@doc DefaultRestSvlVariables}
* (e.g. <js>"$L{my.localized.variable}"</js>).
@@ -125,7 +125,7 @@ public @interface MethodSwagger {
*
* <ul class='notes'>
* <li>
- * The format is either a comma-delimited list of simple
strings or a {@doc juneau-marshall.JsonDetails.SimplifiedJson} array.
+ * The format is either a comma-delimited list of simple
strings or a {@doc SimpleJson} array.
* <li>
* Supports {@doc DefaultRestSvlVariables}
* (e.g. <js>"$L{my.localized.variable}"</js>).
@@ -143,7 +143,7 @@ public @interface MethodSwagger {
*
* <ul class='notes'>
* <li>
- * The format is either a comma-delimited list of simple
strings or a {@doc juneau-marshall.JsonDetails.SimplifiedJson} array.
+ * The format is either a comma-delimited list of simple
strings or a {@doc SimpleJson} array.
* <li>
* Supports {@doc DefaultRestSvlVariables}
* (e.g. <js>"$L{my.localized.variable}"</js>).
@@ -200,7 +200,7 @@ public @interface MethodSwagger {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} array consisting of the
concatenated individual strings.
+ * The format is a {@doc SimpleJson} array consisting of
the concatenated individual strings.
* <br>The leading and trailing <js>'['</js> and
<js>']'</js> characters are optional.
* <li>
* Supports {@doc DefaultRestSvlVariables}
@@ -232,7 +232,7 @@ public @interface MethodSwagger {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} objc consisting of the concatenated
individual strings.
+ * The format is a {@doc SimpleJson} objc consisting of
the concatenated individual strings.
* <br>The leading and trailing <js>'{'</js> and
<js>'}'</js> characters are optional.
* <li>
* Supports {@doc DefaultRestSvlVariables}
@@ -306,7 +306,7 @@ public @interface MethodSwagger {
* Free-form value for the swagger of a resource method.
*
* <p>
- * This is a {@doc juneau-marshall.JsonDetails.SimplifiedJson} object
that makes up the swagger information for this resource method.
+ * This is a {@doc SimpleJson} object that makes up the swagger
information for this resource method.
*
* <p>
* The following are completely equivalent ways of defining the swagger
description of a resource method:
@@ -364,7 +364,7 @@ public @interface MethodSwagger {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object.
+ * The format is a {@doc SimpleJson} object.
* <li>
* The leading/trailing <c>{ }</c> characters are optional.
* <br>The following two example are considered equivalent:
diff --git
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/ResourceSwagger.java
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/ResourceSwagger.java
index 9e8c234..cc8f084 100644
---
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/ResourceSwagger.java
+++
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/ResourceSwagger.java
@@ -96,7 +96,7 @@ public @interface ResourceSwagger {
* Defines the swagger field <c>/info/contact</c>.
*
* <p>
- * A {@doc juneau-marshall.JsonDetails.SimplifiedJson} string with the
following fields:
+ * A {@doc SimpleJson} string with the following fields:
* <p class='bcode w800'>
* {
* name: string,
@@ -138,7 +138,7 @@ public @interface ResourceSwagger {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object.
+ * The format is a {@doc SimpleJson} object.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports {@doc DefaultRestSvlVariables}
@@ -176,7 +176,7 @@ public @interface ResourceSwagger {
* It is used to populate the Swagger license field and to display on
HTML pages.
*
* <p>
- * A {@doc juneau-marshall.JsonDetails.SimplifiedJson} string with the
following fields:
+ * A {@doc SimpleJson} string with the following fields:
* <p class='bcode w800'>
* {
* name: string,
@@ -200,7 +200,7 @@ public @interface ResourceSwagger {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object.
+ * The format is a {@doc SimpleJson} object.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports {@doc DefaultRestSvlVariables}
@@ -219,7 +219,7 @@ public @interface ResourceSwagger {
* It is used to populate the Swagger tags field and to display on HTML
pages.
*
* <p>
- * A {@doc juneau-marshall.JsonDetails.SimplifiedJson} string with the
following fields:
+ * A {@doc SimpleJson} string with the following fields:
* <p class='bcode w800'>
* [
* {
@@ -249,7 +249,7 @@ public @interface ResourceSwagger {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} array.
+ * The format is a {@doc SimpleJson} array.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports {@doc DefaultRestSvlVariables}
@@ -310,7 +310,7 @@ public @interface ResourceSwagger {
* Free-form value for the swagger of a resource.
*
* <p>
- * This is a {@doc juneau-marshall.JsonDetails.SimplifiedJson} object
that makes up the swagger information for this resource.
+ * This is a {@doc SimpleJson} object that makes up the swagger
information for this resource.
*
* <p>
* The following are completely equivalent ways of defining the swagger
description of a resource:
@@ -399,7 +399,7 @@ public @interface ResourceSwagger {
*
* <ul class='notes'>
* <li>
- * The format is a {@doc
juneau-marshall.JsonDetails.SimplifiedJson} object.
+ * The format is a {@doc SimpleJson} object.
* <li>
* The leading/trailing <c>{ }</c> characters are optional.
* <br>The following two example are considered equivalent:
diff --git
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/RestMethod.java
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/RestMethod.java
index 0189b1b..e77fb87 100644
---
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/RestMethod.java
+++
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/RestMethod.java
@@ -952,7 +952,7 @@ public @interface RestMethod {
*
* <ul class='notes'>
* <li>
- * The format is {@doc
juneau-marshall.JsonDetails.SimplifiedJson}.
+ * The format is {@doc SimpleJson}.
* <br>Multiple lines are concatenated with newlines.
* <li>
* The starting and ending <js>'{'</js>/<js>'}'</js>
characters around the entire value are optional.
diff --git
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/RestResource.java
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/RestResource.java
index 227e023..b55346e 100644
---
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/RestResource.java
+++
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/RestResource.java
@@ -1032,6 +1032,49 @@ public @interface RestResource {
* <p>
* Used to customize the headers on responses returned for
statically-served files.
*
+ * <h5 class='section'>Example:</h5>
+ * <p class='bcode w800'>
+ * <jc>// Option #1 - Defined via annotation resolving to a config
file setting with default value.</jc>
+ * <ja>@RestResource</ja>(
+ * staticFileResponseHeaders={
+ * <js>"Cache-Control:
$C{REST/cacheControl,nocache}"</js>,
+ * <js>"My-Header: $C{REST/myHeaderValue}"</js>
+ * }
+ * )
+ * <jk>public class</jk> MyResource {
+ *
+ * <jc>// Option #2 - Defined via builder passed in
through resource constructor.</jc>
+ * <jk>public</jk> MyResource(RestContextBuilder builder)
<jk>throws</jk> Exception {
+ *
+ * <jc>// Using method on builder.</jc>
+ * builder
+ *
.staticFileResponseHeader(<js>"Cache-Control"</js>, <js>"nocache"</js>);
+ *
.staticFileResponseHeaders(<js>"My-Header: foo"</js>);
+ *
+ * <jc>// Same, but using property.</jc>
+ * builder
+ *
.addTo(<jsf>REST_staticFileResponseHeaders</jsf>, <js>"Cache-Control"</js>,
<js>"nocache"</js>);
+ *
.addTo(<jsf>REST_staticFileResponseHeaders</jsf>, <js>"My-Header"</js>,
<js>"foo"</js>);
+ * }
+ *
+ * <jc>// Option #3 - Defined via builder passed in
through init method.</jc>
+ * <ja>@RestHook</ja>(<jsf>INIT</jsf>)
+ * <jk>public void</jk> init(RestContextBuilder builder)
<jk>throws</jk> Exception {
+ *
builder.staticFileResponseHeader(<js>"Cache-Control"</js>, <js>"nocache"</js>);
+ * }
+ * }
+ * </p>
+ *
+ * <p>
+ * Note that headers can also be specified per path-mapping via the
{@link RestResource#staticFiles() @RestResource(staticFiles)} annotation.
+ * <p class='bcode w800'>
+ * <ja>@RestResource</ja>(
+ * staticFiles={
+ *
<js>"htdocs:docs:{'Cache-Control':'max-age=86400, public'}"</js>
+ * }
+ * )
+ * </p>
+ *
* <ul class='notes'>
* <li>
* Supports {@doc DefaultRestSvlVariables}
@@ -1048,10 +1091,79 @@ public @interface RestResource {
* Static file mappings.
*
* <p>
- * Used to define paths and locations of statically-served files such
as images or HTML documents.
+ * Used to define paths and locations of statically-served files such
as images or HTML documents
+ * from the classpath or file system.
+ *
+ * <p>
+ * The format of the value is one of the following:
+ * <ol class='spaced-list'>
+ * <li><js>"path:location"</js>
+ * <li><js>"path:location:headers"</js>
+ * </ol>
+ *
+ * <p>
+ * An example where this class is used is in the {@link
RestResource#staticFiles} annotation:
+ * <p class='bcode w800'>
+ * <jk>package</jk> com.foo.mypackage;
+ *
+ * <ja>@RestResource</ja>(
+ * path=<js>"/myresource"</js>,
+ * staticFiles={
+ * <js>"htdocs:docs"</js>,
+ * <js>"styles:styles"</js>
+ * }
+ * )
+ * <jk>public class</jk> MyResource <jk>extends</jk>
BasicRestServlet {...}
+ * </p>
+ *
+ * <p>
+ * In the example above, given a GET request to the following URL...
+ * <p class='bcode w800'>
+ * /myresource/htdocs/foobar.html
+ * </p>
+ * <br>...the servlet will attempt to find the <c>foobar.html</c> file
in the following location:
+ * <ol class='spaced-list'>
+ * <li><c>com.foo.mypackage.docs</c> package.
+ * </ol>
+ *
+ * <p>
+ * The location is interpreted as an absolute path if it starts with
<js>'/'</js>.
+ * <p class='bcode w800'>
+ * <ja>@RestResource</ja>(
+ * staticFiles={
+ * <js>"htdocs:/docs"</js>
+ * }
+ * )
+ * </p>
+ * <p>
+ * In the example above, given a GET request to the following URL...
+ * <p class='bcode w800'>
+ * /myresource/htdocs/foobar.html
+ * </p>
+ * <br>...the servlet will attempt to find the <c>foobar.html</c> file
in the following location:
+ * <ol class='spaced-list'>
+ * <li><c>docs</c> package (typically under
<c>src/main/resources/docs</c> in your workspace).
+ * <li><c>[working-dir]/docs</c> directory at runtime.
+ * </ol>
+ *
+ * <p>
+ * Response headers can be specified for served files by adding a 3rd
section that consists of a {@doc SimpleJson} object.
+ * <p class='bcode w800'>
+ * <ja>@RestResource</ja>(
+ * staticFiles={
+ *
<js>"htdocs:docs:{'Cache-Control':'max-age=86400, public'}"</js>
+ * }
+ * )
+ * </p>
*
* <ul class='notes'>
* <li>
+ * Mappings are cumulative from super classes.
+ * <li>
+ * Child resources can override mappings made on parent
class resources.
+ * <br>When both parent and child resources map against
the same path, files will be search in the child location
+ * and then the parent location.
+ * <li>
* Supports {@doc DefaultRestSvlVariables}
* (e.g. <js>"$L{my.localized.variable}"</js>).
* </ul>
