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 723134a Javadocs
723134a is described below
commit 723134a16b0f56d9aa449965645bfcc2bd6112c8
Author: JamesBognar <[email protected]>
AuthorDate: Thu May 24 20:27:14 2018 -0400
Javadocs
---
.../apache/juneau/dto/swagger/ui/package-info.java | 18 ++
juneau-doc/src/main/javadoc/javadoc.css | 8 -
juneau-doc/src/main/javadoc/overview.html | 2 +-
.../juneau/rest/client/mock/package-info.java | 18 ++
.../org/apache/juneau/rest/annotation/Body.java | 296 ++++++++++++---------
.../apache/juneau/rest/annotation/FormData.java | 84 +++---
.../org/apache/juneau/rest/annotation/Header.java | 86 +++---
.../org/apache/juneau/rest/annotation/Path.java | 60 +++--
.../org/apache/juneau/rest/annotation/Query.java | 88 +++---
.../juneau/rest/annotation/ResourceSwagger.java | 18 +-
.../apache/juneau/rest/annotation/Response.java | 20 +-
.../juneau/rest/annotation/ResponseHeader.java | 80 +++---
.../apache/juneau/rest/annotation/RestMethod.java | 1 +
.../juneau/rest/annotation/RestResource.java | 3 +-
.../org/apache/juneau/rest/annotation/Status.java | 4 +-
.../org/apache/juneau/rest/mock/package-info.java | 18 ++
.../org/apache/juneau/rest/util/package-info.java | 18 ++
17 files changed, 465 insertions(+), 357 deletions(-)
diff --git
a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/ui/package-info.java
b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/ui/package-info.java
new file mode 100755
index 0000000..af0548f
--- /dev/null
+++
b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/ui/package-info.java
@@ -0,0 +1,18 @@
+//
***************************************************************************************************************************
+// * Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file *
+// * distributed with this work for additional information regarding copyright
ownership. The ASF licenses this file *
+// * to you under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance *
+// * with the License. You may obtain a copy of the License at
*
+// *
*
+// * http://www.apache.org/licenses/LICENSE-2.0
*
+// *
*
+// * Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an *
+// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
express or implied. See the License for the *
+// * specific language governing permissions and limitations under the
License. *
+//
***************************************************************************************************************************
+
+/**
+ * Swagger UI Generator
+ */
+package org.apache.juneau.dto.swagger.ui;
+
diff --git a/juneau-doc/src/main/javadoc/javadoc.css
b/juneau-doc/src/main/javadoc/javadoc.css
index ab50546..691eaf9 100755
--- a/juneau-doc/src/main/javadoc/javadoc.css
+++ b/juneau-doc/src/main/javadoc/javadoc.css
@@ -19,14 +19,6 @@
Overall document style
*/
body {
- background-image: linear-gradient(top, #cddddf 0, #eaeded 20px, #ffffff
70px);
- background-image: -o-linear-gradient(top, #cddddf 0, #eaeded 20px,
#ffffff 70px);
- background-image: -moz-linear-gradient(top, #cddddf 0, #eaeded 20px,
#ffffff 70px);
- background-image: -webkit-linear-gradient(top, #cddddf 0, #eaeded 20px,
#ffffff 70px);
- background-image: -ms-linear-gradient(top, #cddddf 0, #eaeded 20px,
#ffffff 70px);
- background-image: -webkit-gradient(linear, left top, left bottom,
color-stop(0, #cddddf), color-stop(20px, #eaeded), color-stop(70px, #ffffff) );
- background-repeat: no-repeat;
- background-attachment: fixed;
color: #353833;
font-family: Arial, Helvetica, sans-serif;
font-size: 76%;
diff --git a/juneau-doc/src/main/javadoc/overview.html
b/juneau-doc/src/main/javadoc/overview.html
index 2d585fd..5895c90 100644
--- a/juneau-doc/src/main/javadoc/overview.html
+++ b/juneau-doc/src/main/javadoc/overview.html
@@ -22198,7 +22198,7 @@
<code>@RestResource.allowMethodParam</code>
renamed to {@link
org.apache.juneau.rest.annotation.RestResource#allowedMethodParams}.
<li>
<code>@RestMethod.serializersInherit</code> and
<code>@RestMethod.parsersInherit</code> replaced with
- simplified {@link
org.apache.juneau.rest.annotation.RestMethod#inherit() @RestMethod.inherit()}.
+ simplified
<code><del>@RestMethod.inherit()</del></code>.
<li>
Changes to {@link
org.apache.juneau.rest.RequestFormData}:
<ul>
diff --git
a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/mock/package-info.java
b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/mock/package-info.java
new file mode 100644
index 0000000..a991250
--- /dev/null
+++
b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/mock/package-info.java
@@ -0,0 +1,18 @@
+/***************************************************************************************************************************
+ * Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information regarding copyright
ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ *
+
***************************************************************************************************************************/
+
+/**
+ * REST Client Mock API
+ */
+package org.apache.juneau.rest.client.mock;
\ No newline at end of file
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 8300e60..2da93c9 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
@@ -28,26 +28,27 @@ import org.apache.juneau.rest.*;
* <p>
* Identifies a POJO to be used as the body of an HTTP request.
*
- * <h5 class='section'>Example:</h5>
+ * <h5 class='section'>Examples:</h5>
* <p class='bcode w800'>
+ * <jc>// Used on parameter</jc>
* <ja>@RestMethod</ja>(name=<jsf>POST</jsf>)
- * <jk>public void</jk> addPerson(<ja>@Body</ja> Person person) {...}
- *
- * <jc>// ...or...</jc>
- *
+ * <jk>public void</jk> addPet(<ja>@Body</ja> Pet pet) {...}
+ * </p>
+ * <p class='bcode w800'>
+ * <jc>// Used on class</jc>
* <ja>@RestMethod</ja>(name=<jsf>POST</jsf>)
- * <jk>public void</jk> addPerson(Person person) {...}
+ * <jk>public void</jk> addPet(Pet pet) {...}
*
* <ja>@Body</ja>
- * <jk>public class</jk> Person {...}
+ * <jk>public class</jk> Pet {...}
* </p>
*
* <p>
* This is functionally equivalent to the following code...
* <p class='bcode w800'>
* <ja>@RestMethod</ja>(name=<jsf>POST</jsf>)
- * <jk>public void</jk> addPerson(RestRequest req) {
- * Person person = req.getBody().asType(Person.<jk>class</jk>);
+ * <jk>public void</jk> addPet(RestRequest req) {
+ * Pet pet = req.getBody().asType(Pet.<jk>class</jk>);
* ...
* }
* </p>
@@ -56,21 +57,21 @@ import org.apache.juneau.rest.*;
* This annotation can be applied to the following:
* <ul class='spaced-list'>
* <li>
- * Parameters on a {@link RestMethod @RestMethod}.
+ * Parameters on a {@link RestMethod @RestMethod}-annotated
method.
* <li>
* POJO classes.
* </ul>
*
* <p>
- * Any of the following types can be used as an annotated parameter (matched
in the specified order):
+ * Any of the following types can be used (matched in the specified order):
* <ol class='spaced-list'>
* <li>
* {@link Reader}
- * <br><ja>@Body</ja> annotation is optional.
+ * <br><ja>@Body</ja> annotation is optional (it's inferred from
the class type).
* <br><code>Content-Type</code> is always ignored.
* <li>
* {@link InputStream}
- * <br><ja>@Body</ja> annotation is optional.
+ * <br><ja>@Body</ja> annotation is optional (it's inferred from
the class type).
* <br><code>Content-Type</code> is always ignored.
* <li>
* Any <a class='doclink'
href='../../../../../overview-summary.html#juneau-marshall.PojoCategories'>parsable</a>
POJO type.
@@ -111,11 +112,12 @@ import org.apache.juneau.rest.*;
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * Annotation parameter values will be aggregated when used on
POJO parent and child classes.
- * <br>Values on child classes override values on parent classes.
- * <li>
- * Annotation parameter values will be aggregated when used on
both POJOs and REST methods.
- * <br>Values on methods override values on POJO classes.
+ * Annotation values are coalesced from multiple sources in the
following order of precedence:
+ * <ol>
+ * <li><ja>@Body</ja> annotation on parameter.
+ * <li><ja>@Body</ja> annotation on class.
+ * <li><ja>@Body</ja> annotation on parent classes and
interfaces.
+ * </ol>
* </ul>
*
*
@@ -131,53 +133,70 @@ import org.apache.juneau.rest.*;
public @interface Body {
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/description</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=body)/#/description</code>.
+ *
+ * <p>
+ * A brief description of the body. This could contain examples of use.
*
* <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) {...}
+ * <jc>// Used on parameter</jc>
+ * <ja>@RestMethod</ja>(name=<jsf>POST</jsf>)
+ * <jk>public void</jk> addPet(
+ * <ja>@Body</ja>(description=<js>"Pet object to add to
the store"</js>) Pet input
+ * ) {...}
* </p>
* <p class='bcode'>
- * <ja>@RestMethod</ja>(name=<jsf>PUT</jsf>)
- * <jk>public void</jk> doPut(MyBean input) {...}
+ * <jc>// Used on class</jc>
+ * <ja>@RestMethod</ja>(name=<jsf>POST</jsf>)
+ * <jk>public void</jk> addPet(Pet input) {...}
*
- * <ja>@Body</ja>(description=<js>"A description"</js>)
- * <jk>public class</jk> MyBean {...}
+ * <ja>@Body</ja>(description=<js>"Pet object to add to the
store"</js>)
+ * <jk>public class</jk> Pet {...}
* </p>
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is plain-text.
+ * The format is plain text.
* <br>Multiple lines are concatenated with newlines.
* <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 {};
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/required</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=body)/#/required</code>.
*
+ * <p>
+ * Determines whether this parameter is mandatory.
+ * <br>The property MAY be included and its default value is false.
+ *
* <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) {...}
+ * <jc>// Used on parameter</jc>
+ * <ja>@RestMethod</ja>(name=<jsf>POST</jsf>)
+ * <jk>public void</jk> addPet(
+ * <ja>@Body</ja>(required=<js>"true"</js>) Pet input
+ * ) {...}
* </p>
* <p class='bcode'>
- * <ja>@RestMethod</ja>(name=<jsf>PUT</jsf>)
- * <jk>public void</jk> doPut(MyBean input) {...}
+ * <jc>// Used on class</jc>
+ * <ja>@RestMethod</ja>(name=<jsf>POST</jsf>)
+ * <jk>public void</jk> addPet(Pet input) {...}
*
* <ja>@Body</ja>(required=<js>"true"</js>)
- * <jk>public class</jk> MyBean {...}
+ * <jk>public class</jk> Pet {...}
* </p>
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is boolean.
+ * The format is boolean.
* <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>).
@@ -186,34 +205,60 @@ public @interface Body {
String required() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/type</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=body)/#/schema</code>.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * The format is a JSON object.
+ * <br>Multiple lines are concatenated with newlines.
+ * <li>
+ * The leading/trailing <code>{ }</code> characters are
optional.
+ * <br>The following two example are considered equivalent:
+ * <ul>
+ *
<li><code>schema=<js>"{type:'string',format:'binary'}"</js></code>
+ *
<li><code>schema=<js>"type:'string',format:'binary'"</js></code>
+ * <ul>
+ * <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>
+ */
+ String[] schema() default {};
+
+ /**
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=body)/#/schema/$ref</code>.
+ *
+ * <p>
+ * A JSON reference to the schema definition.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * The format is a <a
href='https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03'>JSON
Reference</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>).
+ * </ul>
+ */
+ String $ref() default "";
+
+ /**
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=body)/#/schema/format</code>.
*
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
+ * <jc>// Used on parameter</jc>
* <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 {...}
+ * <jk>public void</jk> setAge(
+ * <ja>@Body</ja>(type=<js>"integer"</js>,
format=<js>"int32"</js>) String input
+ * ) {...}
* </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>
- * <li><js>"boolean"</js>
- * <li><js>"array"</js>
- * <li><js>"file"</js>
- * </ul>
+ * The format is plain text.
* <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>).
@@ -221,59 +266,66 @@ public @interface Body {
*
* <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>
+ * <li class='link'><a class='doclink'
href='https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#dataTypeFormat'>Swagger
specification > Data Type Formats</a>
* </ul>
- *
*/
- String type() default "";
+ String format() default "";
+
+
+
+
+
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/format</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=body)/#/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) {...}
+ * <jc>// Used on parameter</jc>
+ * <ja>@RestMethod</ja>(name=<jsf>POST</jsf>)
+ * <jk>public void</jk> addPet(
+ * <ja>@Body</ja>(type=<js>"object"</js>) Pet input
+ * ) {...}
* </p>
* <p class='bcode'>
- * <ja>@RestMethod</ja>(name=<jsf>PUT</jsf>)
- * <jk>public void</jk> doPut(MyBean input) {...}
+ * <jc>// Used on class</jc>
+ * <ja>@RestMethod</ja>(name=<jsf>POST</jsf>)
+ * <jk>public void</jk> addPet(Pet input) {...}
*
* <ja>@Body</ja>(type=<js>"object"</js>)
- * <jk>public class</jk> MyBean {...}
+ * <jk>public class</jk> Pet {...}
* </p>
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is plain-text:
+ * The format is plain text.
* <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:
+ * The possible values are:
* <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>
+ * <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>
+ * <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>
*
* <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 "";
+ String type() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/pattern</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=body)/#/pattern</code>.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -284,7 +336,7 @@ public @interface Body {
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is plain-text.
+ * The format is plain text.
* <li>
* This string SHOULD be a valid regular expression.
* <li>
@@ -295,7 +347,7 @@ public @interface Body {
String pattern() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/collectionFormat</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=body)/#/collectionFormat</code>.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -322,12 +374,12 @@ public @interface Body {
String collectionFormat() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/maximum</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=body)/#/maximum</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -336,12 +388,12 @@ public @interface Body {
String maximum() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/minimum</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=body)/#/minimum</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -350,12 +402,12 @@ public @interface Body {
String minimum() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/multipleOf</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=body)/#/multipleOf</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -364,12 +416,12 @@ public @interface Body {
String multipleOf() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/maxLength</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=body)/#/maxLength</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -378,12 +430,12 @@ public @interface Body {
String maxLength() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/minLength</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=body)/#/minLength</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -392,12 +444,12 @@ public @interface Body {
String minLength() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/maxItems</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=body)/#/maxItems</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -406,12 +458,12 @@ public @interface Body {
String maxItems() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/minItems</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=body)/#/minItems</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -420,12 +472,12 @@ public @interface Body {
String minItems() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/allowEmptyVals</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=body)/#/allowEmptyVals</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is boolean.
+ * The format is boolean.
* <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>).
@@ -434,12 +486,12 @@ public @interface Body {
String allowEmptyValue() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/exclusiveMaximum</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=body)/#/exclusiveMaximum</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -448,12 +500,12 @@ public @interface Body {
String exclusiveMaximum() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/exclusiveMinimum</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=body)/#/exclusiveMinimum</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -462,12 +514,12 @@ public @interface Body {
String exclusiveMinimum() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/uniqueItems</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=body)/#/uniqueItems</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is boolean.
+ * The format is boolean.
* <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>).
@@ -476,34 +528,12 @@ public @interface Body {
String uniqueItems() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/schema</code>.
- *
- * <h5 class='section'>Notes:</h5>
- * <ul class='spaced-list'>
- * <li>
- * The format of the value is a JSON object.
- * <br>Multiple lines are concatenated with newlines.
- * <li>
- * The leading/trailing <code>{ }</code> characters are
optional.
- * <br>The following two example are considered equivalent:
- * <ul>
- *
<li><code>schema=<js>"{type:'string',format:'binary'}"</js></code>
- *
<li><code>schema=<js>"type:'string',format:'binary'"</js></code>
- * <ul>
- * <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>
- */
- String[] schema() default {};
-
- /**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/default</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=body)/#/default</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is JSON.
+ * The format is any JSON.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports <a class="doclink"
href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time
and request-time variables</a>
@@ -513,12 +543,12 @@ public @interface Body {
String[] _default() default {};
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/enum</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=body)/#/enum</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is a JSON array or
comma-delimited list.
+ * The format is a JSON array or comma-delimited list.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports <a class="doclink"
href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time
and request-time variables</a>
@@ -528,12 +558,12 @@ public @interface Body {
String[] _enum() default {};
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/items</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=body)/#/items</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is a JSON object.
+ * The format is a JSON object.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports <a class="doclink"
href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time
and request-time variables</a>
@@ -543,7 +573,7 @@ public @interface Body {
String[] items() default {};
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/x-example</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=body)/#/x-example</code>.
*
* <p>
* This attribute defines a JSON representation of the body value that
is used by {@link BasicRestInfoProvider} to construct
@@ -552,7 +582,7 @@ public @interface Body {
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is a JSON object or plain-text
string.
+ * The format is a JSON object or plain text string.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports <a class="doclink"
href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time
and request-time variables</a>
@@ -562,7 +592,7 @@ public @interface Body {
String[] example() default {};
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/x-examples</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=body)/#/x-examples</code>.
*
* <p>
* This is a JSON object whose keys are media types and values are
string representations of that value.
@@ -570,7 +600,7 @@ public @interface Body {
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is a JSON object.
+ * The format is a JSON object.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports <a class="doclink"
href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time
and request-time variables</a>
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 acd4540..9b4da1b 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
@@ -103,12 +103,12 @@ public @interface FormData {
String value() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/description</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/description</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is plain-text.
+ * The format is plain text.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports <a class="doclink"
href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time
and request-time variables</a>
@@ -118,12 +118,12 @@ public @interface FormData {
String[] description() default {};
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/required</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/required</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is boolean.
+ * The format is boolean.
* <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>).
@@ -132,7 +132,7 @@ public @interface FormData {
String required() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/type</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/type</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -159,12 +159,12 @@ public @interface FormData {
String type() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/format</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/format</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is plain-text:
+ * The format is plain-text.
* <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>).
@@ -178,12 +178,12 @@ public @interface FormData {
String format() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/pattern</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/pattern</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is plain-text.
+ * The format is plain text.
* <li>
* This string SHOULD be a valid regular expression.
* <li>
@@ -194,7 +194,7 @@ public @interface FormData {
String pattern() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/collectionFormat</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/collectionFormat</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -215,12 +215,12 @@ public @interface FormData {
String collectionFormat() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/maximum</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/maximum</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -229,12 +229,12 @@ public @interface FormData {
String maximum() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/minimum</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/minimum</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -243,12 +243,12 @@ public @interface FormData {
String minimum() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/multipleOf</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/multipleOf</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -257,12 +257,12 @@ public @interface FormData {
String multipleOf() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/maxLength</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/maxLength</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -271,12 +271,12 @@ public @interface FormData {
String maxLength() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/minLength</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/minLength</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -285,12 +285,12 @@ public @interface FormData {
String minLength() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/maxItems</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/maxItems</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -299,12 +299,12 @@ public @interface FormData {
String maxItems() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/minItems</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/minItems</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -313,12 +313,12 @@ public @interface FormData {
String minItems() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/allowEmptyValue</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/allowEmptyValue</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is boolean.
+ * The format is boolean.
* <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>).
@@ -327,12 +327,12 @@ public @interface FormData {
String allowEmptyValue() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/exclusiveMaximum</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/exclusiveMaximum</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -341,12 +341,12 @@ public @interface FormData {
String exclusiveMaximum() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/exclusiveMinimum</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/exclusiveMinimum</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -355,12 +355,12 @@ public @interface FormData {
String exclusiveMinimum() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/uniqueItems</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/uniqueItems</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is boolean.
+ * The format is boolean.
* <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>).
@@ -369,12 +369,12 @@ public @interface FormData {
String uniqueItems() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/schema</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/schema</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is a JSON object.
+ * The format is a JSON object.
* <br>Multiple lines are concatenated with newlines.
* <li>
* The leading/trailing <code>{ }</code> characters are
optional.
@@ -391,7 +391,7 @@ public @interface FormData {
String[] schema() default {};
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/default</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/default</code>.
*
* <p>
* Additionally, this method can be used to define a default value for
a missing form data entry.
@@ -399,7 +399,7 @@ public @interface FormData {
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is JSON.
+ * The format is any JSON.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports <a class="doclink"
href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time
and request-time variables</a>
@@ -409,12 +409,12 @@ public @interface FormData {
String[] _default() default {};
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/enum</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/enum</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is a JSON array or
comma-delimited list.
+ * The format is a JSON array or comma-delimited list.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports <a class="doclink"
href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time
and request-time variables</a>
@@ -424,12 +424,12 @@ public @interface FormData {
String[] _enum() default {};
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/items</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/items</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is a JSON object.
+ * The format is a JSON object.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports <a class="doclink"
href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time
and request-time variables</a>
@@ -439,7 +439,7 @@ public @interface FormData {
String[] items() default {};
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/x-example</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/x-example</code>.
*
* <p>
* This attribute defines a JSON representation of the value that is
used by {@link BasicRestInfoProvider} to construct
@@ -448,7 +448,7 @@ public @interface FormData {
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is a JSON object or plain-text
string.
+ * The format is a JSON object or plain text string.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports <a class="doclink"
href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time
and request-time variables</a>
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 bd62089..1838348 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
@@ -76,12 +76,12 @@ public @interface Header {
String value() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/description</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/description</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is plain-text.
+ * The format is plain text.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports <a class="doclink"
href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time
and request-time variables</a>
@@ -91,12 +91,12 @@ public @interface Header {
String[] description() default {};
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/required</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/required</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is boolean.
+ * The format is boolean.
* <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>).
@@ -105,7 +105,7 @@ public @interface Header {
String required() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/type</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/type</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -132,12 +132,12 @@ public @interface Header {
String type() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/format</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/format</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is plain-text:
+ * The format is plain text.
* <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>).
@@ -151,12 +151,12 @@ public @interface Header {
String format() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/pattern</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/pattern</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is plain-text.
+ * The format is plain text.
* <li>
* This string SHOULD be a valid regular expression.
* <li>
@@ -167,11 +167,13 @@ public @interface Header {
String pattern() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/collectionFormat</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/collectionFormat</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
+ * The format is plain text.
+ * <li>
* The possible value are:
* <ul>
* <li><js>"csv"</js>
@@ -188,12 +190,12 @@ public @interface Header {
String collectionFormat() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/maximum</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/maximum</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -202,12 +204,12 @@ public @interface Header {
String maximum() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/minimum</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/minimum</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -216,12 +218,12 @@ public @interface Header {
String minimum() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/multipleOf</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/multipleOf</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -230,12 +232,12 @@ public @interface Header {
String multipleOf() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/maxLength</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/maxLength</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -244,12 +246,12 @@ public @interface Header {
String maxLength() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/minLength</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/minLength</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -258,12 +260,12 @@ public @interface Header {
String minLength() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/maxItems</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/maxItems</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -272,12 +274,12 @@ public @interface Header {
String maxItems() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/minItems</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/minItems</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -286,12 +288,12 @@ public @interface Header {
String minItems() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/allowEmptyValue</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/allowEmptyValue</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is boolean.
+ * The format is boolean.
* <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>).
@@ -300,12 +302,12 @@ public @interface Header {
String allowEmptyValue() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/exclusiveMaximum</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/exclusiveMaximum</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -314,12 +316,12 @@ public @interface Header {
String exclusiveMaximum() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/exclusiveMinimum</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/exclusiveMinimum</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -328,12 +330,12 @@ public @interface Header {
String exclusiveMinimum() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/uniqueItems</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/uniqueItems</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is boolean.
+ * The format is boolean.
* <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>).
@@ -342,12 +344,12 @@ public @interface Header {
String uniqueItems() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/schema</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/schema</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is a JSON object.
+ * The format is a JSON object.
* <br>Multiple lines are concatenated with newlines.
* <li>
* The leading/trailing <code>{ }</code> characters are
optional.
@@ -364,7 +366,7 @@ public @interface Header {
String[] schema() default {};
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/default</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/default</code>.
*
* <p>
* Additionally, this method can be used to define a default value for
a missing header entry.
@@ -372,7 +374,7 @@ public @interface Header {
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is JSON.
+ * The format is any JSON.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports <a class="doclink"
href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time
and request-time variables</a>
@@ -382,12 +384,12 @@ public @interface Header {
String[] _default() default {};
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/enum</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/enum</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is a JSON array or
comma-delimited list.
+ * The format is a JSON array or comma-delimited list.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports <a class="doclink"
href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time
and request-time variables</a>
@@ -397,12 +399,12 @@ public @interface Header {
String[] _enum() default {};
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/items</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/items</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is a JSON object.
+ * The format is a JSON object.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports <a class="doclink"
href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time
and request-time variables</a>
@@ -412,7 +414,7 @@ public @interface Header {
String[] items() default {};
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/x-example</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/x-example</code>.
*
* <p>
* This attribute defines a JSON representation of the value that is
used by {@link BasicRestInfoProvider} to construct
@@ -421,7 +423,7 @@ public @interface Header {
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is a JSON object or plain-text
string.
+ * The format is a JSON object or plain text string.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports <a class="doclink"
href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time
and request-time variables</a>
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 b8c21a6..a70f6c8 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
@@ -70,12 +70,12 @@ public @interface Path {
String value() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/description</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=path)/#/description</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is plain-text.
+ * The format is plain text.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports <a class="doclink"
href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time
and request-time variables</a>
@@ -85,11 +85,13 @@ public @interface Path {
String[] description() default {};
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/type</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=path)/#/type</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
+ * The format is plain text.
+ * <li>
* The possible values are:
* <ul>
* <li><js>"string"</js>
@@ -112,12 +114,12 @@ public @interface Path {
String type() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/format</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=path)/#/format</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is plain-text:
+ * The format is plain text.
* <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>).
@@ -131,12 +133,12 @@ public @interface Path {
String format() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/pattern</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=path)/#/pattern</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is plain-text.
+ * The format is plain text.
* <li>
* This string SHOULD be a valid regular expression.
* <li>
@@ -147,12 +149,12 @@ public @interface Path {
String pattern() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/maximum</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=path)/#/maximum</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -161,12 +163,12 @@ public @interface Path {
String maximum() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/minimum</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=path)/#/minimum</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -175,12 +177,12 @@ public @interface Path {
String minimum() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/multipleOf</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=path)/#/multipleOf</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -189,12 +191,12 @@ public @interface Path {
String multipleOf() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/maxLength</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=path)/#/maxLength</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -203,12 +205,12 @@ public @interface Path {
String maxLength() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/minLength</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=path)/#/minLength</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -217,12 +219,12 @@ public @interface Path {
String minLength() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/allowEmptyValue</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=path)/#/allowEmptyValue</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is boolean.
+ * The format is boolean.
* <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>).
@@ -231,12 +233,12 @@ public @interface Path {
String allowEmptyValue() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/exclusiveMaximum</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=path)/#/exclusiveMaximum</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -245,12 +247,12 @@ public @interface Path {
String exclusiveMaximum() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/exclusiveMinimum</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=path)/#/exclusiveMinimum</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -259,12 +261,12 @@ public @interface Path {
String exclusiveMinimum() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/schema</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=path)/#/schema</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is a JSON object.
+ * The format is a JSON object.
* <br>Multiple lines are concatenated with newlines.
* <li>
* The leading/trailing <code>{ }</code> characters are
optional.
@@ -281,12 +283,12 @@ public @interface Path {
String[] schema() default {};
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/enum</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=path)/#/enum</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is a JSON array or
comma-delimited list.
+ * The format is a JSON array or comma-delimited list.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports <a class="doclink"
href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time
and request-time variables</a>
@@ -296,7 +298,7 @@ public @interface Path {
String[] _enum() default {};
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/x-example</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=path)/#/x-example</code>.
*
* <p>
* This attribute defines a JSON representation of the value that is
used by {@link BasicRestInfoProvider} to construct
@@ -305,7 +307,7 @@ public @interface Path {
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is a JSON object or plain-text
string.
+ * The format is a JSON object or plain text string.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports <a class="doclink"
href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time
and request-time variables</a>
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 0e4ee84..acbde1e 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
@@ -99,12 +99,12 @@ public @interface Query {
String value() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/description</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/description</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is plain-text.
+ * The format is plain text.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports <a class="doclink"
href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time
and request-time variables</a>
@@ -114,12 +114,12 @@ public @interface Query {
String[] description() default {};
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/required</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/required</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is boolean.
+ * The format is boolean.
* <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>).
@@ -128,11 +128,13 @@ public @interface Query {
String required() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/type</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/type</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
+ * The format is plain text.
+ * <li>
* The possible values are:
* <ul>
* <li><js>"string"</js>
@@ -155,12 +157,12 @@ public @interface Query {
String type() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/format</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/format</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is plain-text:
+ * The format is plain text.
* <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>).
@@ -174,12 +176,12 @@ public @interface Query {
String format() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/pattern</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/pattern</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is plain-text.
+ * The format is plain text.
* <li>
* This string SHOULD be a valid regular expression.
* <li>
@@ -190,11 +192,13 @@ public @interface Query {
String pattern() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/collectionFormat</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/collectionFormat</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
+ * The format is plain text.
+ * <li>
* The possible value are:
* <ul>
* <li><js>"csv"</js>
@@ -211,12 +215,12 @@ public @interface Query {
String collectionFormat() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/maximum</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/maximum</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -225,12 +229,12 @@ public @interface Query {
String maximum() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/minimum</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/minimum</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -239,12 +243,12 @@ public @interface Query {
String minimum() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/multipleOf</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/multipleOf</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -253,12 +257,12 @@ public @interface Query {
String multipleOf() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/maxLength</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/maxLength</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -267,12 +271,12 @@ public @interface Query {
String maxLength() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/minLength</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/minLength</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -281,12 +285,12 @@ public @interface Query {
String minLength() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/maxItems</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/maxItems</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -295,12 +299,12 @@ public @interface Query {
String maxItems() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/minItems</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/minItems</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -309,12 +313,12 @@ public @interface Query {
String minItems() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/allowEmptyValue</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/allowEmptyValue</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is boolean.
+ * The format is boolean.
* <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>).
@@ -323,12 +327,12 @@ public @interface Query {
String allowEmptyValue() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/exclusiveMaximum</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/exclusiveMaximum</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -337,12 +341,12 @@ public @interface Query {
String exclusiveMaximum() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/exclusiveMinimum</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/exclusiveMinimum</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -351,12 +355,12 @@ public @interface Query {
String exclusiveMinimum() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/uniqueItems</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/uniqueItems</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is boolean.
+ * The format is boolean.
* <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>).
@@ -365,12 +369,12 @@ public @interface Query {
String uniqueItems() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/schema</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/schema</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is a JSON object.
+ * The format is a JSON object.
* <br>Multiple lines are concatenated with newlines.
* <li>
* The leading/trailing <code>{ }</code> characters are
optional.
@@ -387,7 +391,7 @@ public @interface Query {
String[] schema() default {};
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/default</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/default</code>.
*
* <p>
* Additionally, this method can be used to define a default value for
a missing query entry.
@@ -395,7 +399,7 @@ public @interface Query {
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is JSON.
+ * The format is any JSON.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports <a class="doclink"
href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time
and request-time variables</a>
@@ -405,12 +409,12 @@ public @interface Query {
String[] _default() default {};
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/enum</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/enum</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is a JSON array or
comma-delimited list.
+ * The format is a JSON array or comma-delimited list.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports <a class="doclink"
href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time
and request-time variables</a>
@@ -420,12 +424,12 @@ public @interface Query {
String[] _enum() default {};
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/items</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/items</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is a JSON object.
+ * The format is a JSON object.
* <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>).
@@ -434,7 +438,7 @@ public @interface Query {
String[] items() default {};
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/parameters/#/x-example</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/x-example</code>.
*
* <p>
* This attribute defines a JSON representation of the value that is
used by {@link BasicRestInfoProvider} to construct
@@ -443,7 +447,7 @@ public @interface Query {
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is a JSON object or plain-text
string.
+ * The format is a JSON object or plain text string.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports <a class="doclink"
href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time
and request-time variables</a>
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 ee88e70..7577f73 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
@@ -73,7 +73,7 @@ public @interface ResourceSwagger {
String[] value() default {};
/**
- * Defines the swagger value <code>/info/title</code>.
+ * Defines the swagger field <code>/info/title</code>.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -106,7 +106,7 @@ public @interface ResourceSwagger {
String[] title() default {};
/**
- * Defines the swagger value <code>/info/description</code>.
+ * Defines the swagger field <code>/info/description</code>.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -123,7 +123,7 @@ public @interface ResourceSwagger {
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is plain-text.
+ * The format is plain text.
* <br>Multiple lines are concatenated with newlines.
* <li>
* The precedence of lookup for this field is:
@@ -142,7 +142,7 @@ public @interface ResourceSwagger {
String[] description() default {};
/**
- * Defines the swagger value <code>/info/contact</code>.
+ * Defines the swagger field <code>/info/contact</code>.
*
* <p>
* A simplified JSON string with the following fields:
@@ -198,7 +198,7 @@ public @interface ResourceSwagger {
String[] contact() default {};
/**
- * Defines the swagger value <code>/externalDocs</code>.
+ * Defines the swagger field <code>/externalDocs</code>.
*
* <p>
* It is used to populate the Swagger external documentation field and
to display on HTML pages.
@@ -239,7 +239,7 @@ public @interface ResourceSwagger {
String[] externalDocs() default {};
/**
- * Defines the swagger value <code>/info/license</code>.
+ * Defines the swagger field <code>/info/license</code>.
*
* <p>
* It is used to populate the Swagger license field and to display on
HTML pages.
@@ -280,7 +280,7 @@ public @interface ResourceSwagger {
String[] license() default {};
/**
- * Defines the swagger value <code>/tags</code>.
+ * Defines the swagger field <code>/tags</code>.
*
*
* Optional tagging information for the exposed API.
@@ -330,7 +330,7 @@ public @interface ResourceSwagger {
String[] tags() default {};
/**
- * Defines the swagger value <code>/info/termsOfService</code>.
+ * Defines the swagger field <code>/info/termsOfService</code>.
*
*
* Optional servlet terms-of-service for this API.
@@ -355,7 +355,7 @@ public @interface ResourceSwagger {
String[] termsOfService() default {};
/**
- * Defines the swagger value <code>/info/version</code>.
+ * Defines the swagger field <code>/info/version</code>.
*
*
*
diff --git
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Response.java
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Response.java
index e39b9b2..0f6f21a 100644
---
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Response.java
+++
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Response.java
@@ -117,12 +117,12 @@ public @interface Response {
int value() default 0;
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/responses/{status-code}/description</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/description</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is plain-text.
+ * The format is plain text.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports <a class="doclink"
href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time
and request-time variables</a>
@@ -132,12 +132,12 @@ public @interface Response {
String[] description() default {};
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/responses/{status-code}/schema</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/schema</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is a JSON object.
+ * The format is a JSON object.
* <br>Multiple lines are concatenated with newlines.
* <li>
* The leading/trailing <code>{ }</code> characters are
optional.
@@ -154,12 +154,12 @@ public @interface Response {
String[] schema() default {};
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/responses/{status-code}/headers</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is a JSON object.
+ * The format is a JSON object.
* <br>Multiple lines are concatenated with newlines.
* <li>
* The leading/trailing <code>{ }</code> characters are
optional.
@@ -176,7 +176,7 @@ public @interface Response {
String[] headers() default {};
/**
- * Used for populating the Swagger field
<code>/paths/{path}/{method}/responses/{status-code}/x-examples</code>.
+ * Used for populating the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/x-examples</code>.
*
* <p>
* The format of the example should be a JSON representation of the
POJO being serialized.
@@ -186,7 +186,7 @@ public @interface Response {
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is any valid JSON.
+ * The format is any JSON.
* <br>Multiple lines are concatenated with newlines.
* <li>
* The leading/trailing <code>{ }</code> characters are
optional.
@@ -203,7 +203,7 @@ public @interface Response {
String[] example() default {};
/**
- * Used for populating the Swagger field
<code>/paths/{path}/{method}/responses/{status-code}/examples</code>.
+ * Used for populating the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/examples</code>.
*
* <p>
* The format is a JSON object with keys as media types and values as
string representations of the body response.
@@ -211,7 +211,7 @@ public @interface Response {
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is a JSON object.
+ * The format is a JSON object.
* <br>Multiple lines are concatenated with newlines.
* <li>
* The leading/trailing <code>{ }</code> characters are
optional.
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 35bba7f..8062a0d 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
@@ -72,7 +72,7 @@ public @interface ResponseHeader {
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is a comma-delimited list of
HTTP status codes that this header applies to.
+ * The is a comma-delimited list of HTTP status codes that
this header applies to.
* <li>
* The default value is <js>"200"</js>.
* </ul>
@@ -85,7 +85,7 @@ public @interface ResponseHeader {
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is a comma-delimited list of
HTTP status codes that this header applies to.
+ * The format is a comma-delimited list of HTTP status
codes that this header applies to.
* <li>
* The default value is <js>"200"</js>.
* </ul>
@@ -134,12 +134,12 @@ public @interface ResponseHeader {
Class<? extends HttpPartSerializer> serializer() default
HttpPartSerializer.Null.class;
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/description</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/description</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is plain-text.
+ * The format is plain text.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports <a class="doclink"
href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time
and request-time variables</a>
@@ -149,11 +149,13 @@ public @interface ResponseHeader {
String[] description() default {};
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/type</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/type</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
+ * The format is plain text.
+ * <li>
* The possible values are:
* <ul>
* <li><js>"string"</js>
@@ -175,12 +177,12 @@ public @interface ResponseHeader {
String type() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/format</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/format</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is plain-text:
+ * The format is plain text:
* <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>).
@@ -194,11 +196,13 @@ public @interface ResponseHeader {
String format() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/collectionFormat</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/collectionFormat</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
+ * The format is plain text:
+ * <li>
* The possible value are:
* <ul>
* <li><js>"csv"</js>
@@ -215,7 +219,7 @@ public @interface ResponseHeader {
String collectionFormat() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/$ref</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/$ref</code>.
*
* <p>
* Denotes a reference to a definition object.
@@ -223,7 +227,7 @@ public @interface ResponseHeader {
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is plain-text:
+ * The format is plain text.
* <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>).
@@ -232,12 +236,12 @@ public @interface ResponseHeader {
String $ref() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/maximum</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/maximum</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -246,12 +250,12 @@ public @interface ResponseHeader {
String maximum() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/minimum</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/minimum</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -260,12 +264,12 @@ public @interface ResponseHeader {
String minimum() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/multipleOf</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/multipleOf</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -274,12 +278,12 @@ public @interface ResponseHeader {
String multipleOf() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/maxLength</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/maxLength</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -288,12 +292,12 @@ public @interface ResponseHeader {
String maxLength() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/minLength</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/minLength</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -302,12 +306,12 @@ public @interface ResponseHeader {
String minLength() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/maxItems</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/maxItems</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -316,12 +320,12 @@ public @interface ResponseHeader {
String maxItems() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/minItems</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/minItems</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -330,12 +334,12 @@ public @interface ResponseHeader {
String minItems() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/exclusiveMaximum</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/exclusiveMaximum</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -344,12 +348,12 @@ public @interface ResponseHeader {
String exclusiveMaximum() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/exclusiveMinimum</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/exclusiveMinimum</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is numeric.
+ * The format is numeric.
* <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>).
@@ -358,12 +362,12 @@ public @interface ResponseHeader {
String exclusiveMinimum() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/uniqueItems</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/uniqueItems</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is boolean.
+ * The format is boolean.
* <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>).
@@ -372,12 +376,12 @@ public @interface ResponseHeader {
String uniqueItems() default "";
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/items</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/items</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is a JSON object.
+ * The format is a JSON object.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports <a class="doclink"
href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time
and request-time variables</a>
@@ -387,12 +391,12 @@ public @interface ResponseHeader {
String[] items() default {};
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/default</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/default</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is JSON.
+ * The format is any JSON.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports <a class="doclink"
href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time
and request-time variables</a>
@@ -402,12 +406,12 @@ public @interface ResponseHeader {
String[] _default() default {};
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/enum</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/enum</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is a JSON array or
comma-delimited list.
+ * The format is a JSON array or comma-delimited list.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports <a class="doclink"
href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time
and request-time variables</a>
@@ -417,7 +421,7 @@ public @interface ResponseHeader {
String[] _enum() default {};
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/x-example</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/x-example</code>.
*
* <p>
* This attribute defines a JSON representation of the body value that
is used by {@link BasicRestInfoProvider} to construct
@@ -426,7 +430,7 @@ public @interface ResponseHeader {
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is a JSON object or plain-text
string.
+ * The format is a JSON object or plain text string.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports <a class="doclink"
href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time
and request-time variables</a>
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 bfac48d..85d524b 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
@@ -771,6 +771,7 @@ public @interface RestMethod {
*
* <h5 class='section'>See Also:</h5>
* <ul>
+ * <li class='ja'>{@link MethodSwagger}
* <li class='jm'>{@link RestInfoProvider#getSwagger(RestRequest)}
* </ul>
*/
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 788259e..4e694b0 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
@@ -154,7 +154,7 @@ public @interface RestResource {
Class<? extends RestCallHandler> callHandler() default
RestCallHandler.Null.class;
/**
- * Children.
+ * REST children.
*
* <p>
* Defines children of this resource.
@@ -873,6 +873,7 @@ public @interface RestResource {
*
* <h5 class='section'>See Also:</h5>
* <ul>
+ * <li class='ja'>{@link ResourceSwagger}
* <li class='jm'>{@link RestInfoProvider#getSwagger(RestRequest)}
* </ul>
*/
diff --git
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Status.java
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Status.java
index e8aedd0..a9942dc 100644
---
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Status.java
+++
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Status.java
@@ -116,12 +116,12 @@ public @interface Status {
int value() default 0;
/**
- * Defines the swagger value
<code>/paths/{path}/{method}/responses/{status-code}/description</code>.
+ * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/description</code>.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
- * The format of the value is plain-text.
+ * The format is plain text.
* <br>Multiple lines are concatenated with newlines.
* <li>
* Supports <a class="doclink"
href="../../../../../overview-summary.html#DefaultRestSvlVariables">initialization-time
and request-time variables</a>
diff --git
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/mock/package-info.java
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/mock/package-info.java
new file mode 100644
index 0000000..ba27d99
--- /dev/null
+++
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/mock/package-info.java
@@ -0,0 +1,18 @@
+/***************************************************************************************************************************
+ * Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information regarding copyright
ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ *
+
***************************************************************************************************************************/
+
+/**
+ * REST Server Mock API
+ */
+package org.apache.juneau.rest.mock;
\ No newline at end of file
diff --git
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/util/package-info.java
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/util/package-info.java
new file mode 100644
index 0000000..a03def9
--- /dev/null
+++
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/util/package-info.java
@@ -0,0 +1,18 @@
+/***************************************************************************************************************************
+ * Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information regarding copyright
ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ *
+
***************************************************************************************************************************/
+
+/**
+ * REST Server Utilities
+ */
+package org.apache.juneau.rest.util;
\ No newline at end of file
--
To stop receiving notification emails like this one, please contact
[email protected].
