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 89d5a25 Javadocs.
89d5a25 is described below
commit 89d5a25875c991ec9a459756fbd07c3db6109ad4
Author: JamesBognar <[email protected]>
AuthorDate: Sun Jun 10 21:31:58 2018 -0400
Javadocs.
---
.../org/apache/juneau/rest/annotation/Body.java | 12 +-
.../org/apache/juneau/rest/annotation/Contact.java | 40 +++-
.../juneau/rest/annotation/ExternalDocs.java | 28 ++-
.../apache/juneau/rest/annotation/FormData.java | 49 +++--
.../org/apache/juneau/rest/annotation/Header.java | 46 ++---
.../org/apache/juneau/rest/annotation/Items.java | 224 ++++++++++++++++++++-
.../org/apache/juneau/rest/annotation/License.java | 27 ++-
.../org/apache/juneau/rest/annotation/Path.java | 32 +--
.../org/apache/juneau/rest/annotation/Query.java | 46 ++---
.../apache/juneau/rest/annotation/Response.java | 12 +-
.../juneau/rest/annotation/ResponseHeader.java | 40 ++--
.../juneau/rest/annotation/ResponseStatus.java | 4 +-
.../org/apache/juneau/rest/annotation/Schema.java | 185 ++++++++++++++---
.../org/apache/juneau/rest/annotation/Tag.java | 44 +++-
14 files changed, 635 insertions(+), 154 deletions(-)
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 cc5f889..cbc434e 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
@@ -173,7 +173,7 @@ public @interface Body {
//=================================================================================================================
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=body)/#/description</code>.
+ * <mk>description</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <p>
* A brief description of the body. This could contain examples of use.
@@ -210,7 +210,7 @@ public @interface Body {
String[] description() default {};
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=body)/#/required</code>.
+ * <mk>required</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <p>
* Determines whether this parameter is mandatory.
@@ -249,7 +249,7 @@ public @interface Body {
//=================================================================================================================
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=body)/#/schema</code>.
+ * <mk>schema</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -271,7 +271,7 @@ public @interface Body {
Schema schema() default @Schema;
/**
- * Serialized example for the body.
+ * TODO
*
* <p>
* This is the JSON or String representation of an example of the body.
@@ -369,7 +369,7 @@ public @interface Body {
String[] example() default {};
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=body)/#/x-examples</code>.
+ * TODO
*
* <p>
* This is a JSON object whose keys are media types and values are
string representations of that value.
@@ -406,7 +406,7 @@ public @interface Body {
String[] examples() default {};
/**
- * Free-form value for the swagger field
<code>/paths/{path}/{method}/parameters(in=body)/#</code>
+ * Free-form value for the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <p>
* This is a JSON object that makes up the swagger information for this
parameter-info.
diff --git
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Contact.java
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Contact.java
index 802737e..5dc12cf 100644
---
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Contact.java
+++
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Contact.java
@@ -61,12 +61,50 @@ import java.lang.annotation.*;
@Inherited
public @interface Contact {
+ /**
+ * <mk>name</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#contactObject";>Contact</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * The format is a plain-text string.
+ * <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 name() default "";
+
+ /**
+ * <mk>url</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#contactObject";>Contact</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * The format is a plain-text string.
+ * <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 url() default "";
+
+ /**
+ * <mk>email</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#contactObject";>Contact</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * The format is a plain-text string.
+ * <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 email() default "";
/**
- * Free-form value for the swagger field <code>/info/contact</code>
+ * Free-form value for the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#contactObject";>Contact</a> object.
*
* <p>
* This is a JSON object that makes up the swagger information for this
field.
diff --git
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/ExternalDocs.java
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/ExternalDocs.java
index f0561b1..f205b8f 100644
---
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/ExternalDocs.java
+++
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/ExternalDocs.java
@@ -22,11 +22,37 @@ package org.apache.juneau.rest.annotation;
*/
public @interface ExternalDocs {
+ /**
+ * <mk>description</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#externalDocumentationObject";>ExternalDocumentation</a>
object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * The format is a 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>
+ * (e.g. <js>"$L{my.localized.variable}"</js>).
+ * </ul>
+ */
String[] description() default {};
+
+ /**
+ * <mk>url</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#externalDocumentationObject";>ExternalDocumentation</a>
object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * The format is a plain-text string.
+ * <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 url() default "";
/**
- * Free-form value for External Documentation objects in Swagger
+ * Free-form value for the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#externalDocumentationObject";>ExternalDocumentation</a>
object.
*
* <p>
* This is a JSON object that makes up the swagger information for this
field.
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 d195100..3b02e25 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
@@ -14,14 +14,11 @@ package org.apache.juneau.rest.annotation;
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.*;
-import static org.apache.juneau.rest.helper.Ok.*;
import java.lang.annotation.*;
import org.apache.juneau.httppart.*;
import org.apache.juneau.rest.*;
-import org.apache.juneau.rest.exception.*;
-import org.apache.juneau.rest.helper.*;
/**
* Annotation that can be applied to a parameter of a {@link RestMethod
@RestMethod} annotated method to identify it as a form post
@@ -101,7 +98,7 @@ public @interface FormData {
Class<? extends HttpPartParser> parser() default
HttpPartParser.Null.class;
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/description</code>.
+ * <mk>description</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -116,7 +113,7 @@ public @interface FormData {
String[] description() default {};
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/required</code>.
+ * <mk>required</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -130,7 +127,7 @@ public @interface FormData {
String required() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/type</code>.
+ * <mk>type</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -157,7 +154,7 @@ public @interface FormData {
String type() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/format</code>.
+ * <mk>format</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -176,7 +173,7 @@ public @interface FormData {
String format() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/pattern</code>.
+ * <mk>pattern</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -192,7 +189,7 @@ public @interface FormData {
String pattern() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/collectionFormat</code>.
+ * <mk>collectionFormat</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -213,7 +210,7 @@ public @interface FormData {
String collectionFormat() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/maximum</code>.
+ * <mk>maximum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -227,7 +224,7 @@ public @interface FormData {
String maximum() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/minimum</code>.
+ * <mk>minimum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -241,7 +238,7 @@ public @interface FormData {
String minimum() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/multipleOf</code>.
+ * <mk>multipleOf</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -255,7 +252,7 @@ public @interface FormData {
String multipleOf() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/maxLength</code>.
+ * <mk>maxLength</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -269,7 +266,7 @@ public @interface FormData {
String maxLength() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/minLength</code>.
+ * <mk>minLength</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -283,7 +280,7 @@ public @interface FormData {
String minLength() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/maxItems</code>.
+ * <mk>maxItems</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -297,7 +294,7 @@ public @interface FormData {
String maxItems() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/minItems</code>.
+ * <mk>minItems</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -311,7 +308,7 @@ public @interface FormData {
String minItems() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/allowEmptyValue</code>.
+ * <mk>allowEmptyValue</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -325,7 +322,7 @@ public @interface FormData {
String allowEmptyValue() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/exclusiveMaximum</code>.
+ * <mk>exclusiveMaximum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -339,7 +336,7 @@ public @interface FormData {
String exclusiveMaximum() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/exclusiveMinimum</code>.
+ * <mk>exclusiveMinimum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -353,7 +350,7 @@ public @interface FormData {
String exclusiveMinimum() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/uniqueItems</code>.
+ * <mk>uniqueItems</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -367,7 +364,7 @@ public @interface FormData {
String uniqueItems() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/schema</code>.
+ * <mk>schema</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -389,7 +386,7 @@ public @interface FormData {
Schema schema() default @Schema;
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/default</code>.
+ * <mk>default</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <p>
* Additionally, this method can be used to define a default value for
a missing form data entry.
@@ -407,7 +404,7 @@ public @interface FormData {
String[] _default() default {};
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/enum</code>.
+ * <mk>enum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -422,7 +419,7 @@ public @interface FormData {
String[] _enum() default {};
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/items</code>.
+ * <mk>items</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -437,7 +434,7 @@ public @interface FormData {
Items items() default @Items;
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=formData)/#/x-example</code>.
+ * TODO
*
* <p>
* This attribute defines a JSON representation of the value that is
used by {@link BasicRestInfoProvider} to construct
@@ -456,7 +453,7 @@ public @interface FormData {
String[] example() default {};
/**
- * Free-form value for the swagger field
<code>/paths/{path}/{method}/parameters(in=form)/#</code>
+ * Free-form value for the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <p>
* This is a JSON object that makes up the swagger information for this
field.
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 10a86b2..81c9a63 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
@@ -70,7 +70,7 @@ public @interface Header {
Class<? extends HttpPartParser> parser() default
HttpPartParser.Null.class;
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/description</code>.
+ * <mk>description</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -85,7 +85,7 @@ public @interface Header {
String[] description() default {};
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/required</code>.
+ * <mk>required</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -99,7 +99,7 @@ public @interface Header {
String required() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/type</code>.
+ * <mk>type</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -126,7 +126,7 @@ public @interface Header {
String type() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/format</code>.
+ * <mk>format</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -145,7 +145,7 @@ public @interface Header {
String format() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/pattern</code>.
+ * <mk>pattern</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -161,7 +161,7 @@ public @interface Header {
String pattern() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/collectionFormat</code>.
+ * <mk>collectionFormat</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -184,7 +184,7 @@ public @interface Header {
String collectionFormat() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/maximum</code>.
+ * <mk>maximum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -198,7 +198,7 @@ public @interface Header {
String maximum() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/minimum</code>.
+ * <mk>minimum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -212,7 +212,7 @@ public @interface Header {
String minimum() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/multipleOf</code>.
+ * <mk>multipleOf</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -226,7 +226,7 @@ public @interface Header {
String multipleOf() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/maxLength</code>.
+ * <mk>maxLength</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -240,7 +240,7 @@ public @interface Header {
String maxLength() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/minLength</code>.
+ * <mk>minLength</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -254,7 +254,7 @@ public @interface Header {
String minLength() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/maxItems</code>.
+ * <mk>maxItems</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -268,7 +268,7 @@ public @interface Header {
String maxItems() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/minItems</code>.
+ * <mk>minItems</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -282,7 +282,7 @@ public @interface Header {
String minItems() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/allowEmptyValue</code>.
+ * <mk>allowEmptyValue</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -296,7 +296,7 @@ public @interface Header {
String allowEmptyValue() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/exclusiveMaximum</code>.
+ * <mk>exclusiveMaximum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -310,7 +310,7 @@ public @interface Header {
String exclusiveMaximum() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/exclusiveMinimum</code>.
+ * <mk>exclusiveMinimum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -324,7 +324,7 @@ public @interface Header {
String exclusiveMinimum() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/uniqueItems</code>.
+ * <mk>uniqueItems</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -338,7 +338,7 @@ public @interface Header {
String uniqueItems() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/schema</code>.
+ * <mk>schema</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -360,7 +360,7 @@ public @interface Header {
Schema schema() default @Schema;
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/default</code>.
+ * <mk>default</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <p>
* Additionally, this method can be used to define a default value for
a missing header entry.
@@ -378,7 +378,7 @@ public @interface Header {
String[] _default() default {};
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/enum</code>.
+ * <mk>enum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -393,7 +393,7 @@ public @interface Header {
String[] _enum() default {};
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/items</code>.
+ * <mk>items</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -408,7 +408,7 @@ public @interface Header {
Items items() default @Items;
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#/x-example</code>.
+ * TODO
*
* <p>
* This attribute defines a JSON representation of the value that is
used by {@link BasicRestInfoProvider} to construct
@@ -427,7 +427,7 @@ public @interface Header {
String[] example() default {};
/**
- * Free-form value for the swagger field
<code>/paths/{path}/{method}/parameters(in=header)/#</code>
+ * Free-form value for the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <p>
* This is a JSON object that makes up the swagger information for this
field.
diff --git
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Items.java
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Items.java
index 604a52e..3c881d7 100644
---
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Items.java
+++
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Items.java
@@ -37,26 +37,246 @@ import java.lang.annotation.*;
@Inherited
public @interface Items {
+ /**
+ * <mk>type</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * The format is a plain-text string.
+ * <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 type() default "";
+
+ /**
+ * <mk>format</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * The format is a plain-text string.
+ * <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 format() default "";
+
+ /**
+ * <mk>collectionFormat</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * The format is a plain-text string.
+ * <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 collectionFormat() default "";
+
+ /**
+ * <mk>pattern</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * The format is a plain-text string.
+ * <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 pattern() default "";
- String $ref() default "";
+
+ /**
+ * <mk>maximum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * The format is a plain-text string.
+ * <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 maximum() default "";
+
+ /**
+ * <mk>minimum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * The format is a plain-text string.
+ * <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 minimum() default "";
+
+ /**
+ * <mk>multipleOf</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * The format is a plain-text string.
+ * <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 multipleOf() default "";
+
+ /**
+ * <mk>maxLength</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * The format is a plain-text string.
+ * <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 maxLength() default "";
+
+ /**
+ * <mk>minLength</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * The format is a plain-text string.
+ * <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 minLength() default "";
+
+ /**
+ * <mk>maxItems</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * The format is a plain-text string.
+ * <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 maxItems() default "";
+
+ /**
+ * <mk>minItems</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * The format is a plain-text string.
+ * <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 minItems() default "";
+
+ /**
+ * <mk>exclusiveMaximum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * The format is a plain-text string.
+ * <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 exclusiveMaximum() default "";
+
+ /**
+ * <mk>exclusiveMinimum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * The format is a plain-text string.
+ * <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 exclusiveMinimum() default "";
+
+ /**
+ * <mk>uniqueItems</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * The format is a plain-text string.
+ * <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 uniqueItems() default "";
+
+ /**
+ * <mk>default</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * The format is a plain-text string.
+ * <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[] _default() default {};
+
+ /**
+ * <mk>enum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * The format is a plain-text string.
+ * <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[] _enum() default {};
/**
- * Free-form value for Items objects in Swagger
+ * <mk>$ref</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * The format is a plain-text string.
+ * <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 "";
+
+ /**
+ * Free-form value for the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#itemsObject";>Items</a> object.
*
* <p>
* This is a JSON object that makes up the swagger information for this
field.
diff --git
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/License.java
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/License.java
index df415a5..f4234df 100644
---
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/License.java
+++
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/License.java
@@ -37,11 +37,36 @@ import java.lang.annotation.*;
@Inherited
public @interface License {
+ /**
+ * <mk>name</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#licenseObject";>License</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * The format is a plain-text string.
+ * <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 name() default "";
+
+ /**
+ * <mk>url</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#licenseObject";>License</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * The format is a plain-text string.
+ * <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 url() default "";
/**
- * Free-form value for the swagger field <code>/info/license</code>
+ * Free-form value for the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#licenseObject";>License</a> object.
*
* <p>
* This is a JSON object that makes up the swagger information for this
field.
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 9cc9c4e..9d7fbb3 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
@@ -64,7 +64,7 @@ public @interface Path {
Class<? extends HttpPartParser> parser() default
HttpPartParser.Null.class;
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=path)/#/description</code>.
+ * <mk>description</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -79,7 +79,7 @@ public @interface Path {
String[] description() default {};
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=path)/#/type</code>.
+ * <mk>type</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -108,7 +108,7 @@ public @interface Path {
String type() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=path)/#/format</code>.
+ * <mk>format</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -127,7 +127,7 @@ public @interface Path {
String format() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=path)/#/pattern</code>.
+ * <mk>pattern</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -143,7 +143,7 @@ public @interface Path {
String pattern() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=path)/#/maximum</code>.
+ * <mk>maximum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -157,7 +157,7 @@ public @interface Path {
String maximum() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=path)/#/minimum</code>.
+ * <mk>minimum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -171,7 +171,7 @@ public @interface Path {
String minimum() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=path)/#/multipleOf</code>.
+ * <mk>multipleOf</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -185,7 +185,7 @@ public @interface Path {
String multipleOf() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=path)/#/maxLength</code>.
+ * <mk>maxLength</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -199,7 +199,7 @@ public @interface Path {
String maxLength() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=path)/#/minLength</code>.
+ * <mk>minLength</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -213,7 +213,7 @@ public @interface Path {
String minLength() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=path)/#/allowEmptyValue</code>.
+ * <mk>allowEmptyValue</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -227,7 +227,7 @@ public @interface Path {
String allowEmptyValue() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=path)/#/exclusiveMaximum</code>.
+ * <mk>exclusiveMaximum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -241,7 +241,7 @@ public @interface Path {
String exclusiveMaximum() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=path)/#/exclusiveMinimum</code>.
+ * <mk>exclusiveMinimum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -255,7 +255,7 @@ public @interface Path {
String exclusiveMinimum() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=path)/#/schema</code>.
+ * <mk>schema</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -277,7 +277,7 @@ public @interface Path {
Schema schema() default @Schema;
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=path)/#/enum</code>.
+ * <mk>enum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -292,7 +292,7 @@ public @interface Path {
String[] _enum() default {};
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=path)/#/x-example</code>.
+ * TODO
*
* <p>
* This attribute defines a JSON representation of the value that is
used by {@link BasicRestInfoProvider} to construct
@@ -311,7 +311,7 @@ public @interface Path {
String[] example() default {};
/**
- * Free-form value for the swagger field
<code>/paths/{path}/{method}/parameters(in=path)/#</code>
+ * Free-form value for the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <p>
* This is a JSON object that makes up the swagger information for this
field.
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 aa1e538..5c5be57 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
@@ -93,7 +93,7 @@ public @interface Query {
Class<? extends HttpPartParser> parser() default
HttpPartParser.Null.class;
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/description</code>.
+ * <mk>description</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -108,7 +108,7 @@ public @interface Query {
String[] description() default {};
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/required</code>.
+ * <mk>required</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -122,7 +122,7 @@ public @interface Query {
String required() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/type</code>.
+ * <mk>type</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -151,7 +151,7 @@ public @interface Query {
String type() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/format</code>.
+ * <mk>format</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -170,7 +170,7 @@ public @interface Query {
String format() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/pattern</code>.
+ * <mk>pattern</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -186,7 +186,7 @@ public @interface Query {
String pattern() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/collectionFormat</code>.
+ * <mk>collectionFormat</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -209,7 +209,7 @@ public @interface Query {
String collectionFormat() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/maximum</code>.
+ * <mk>maximum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -223,7 +223,7 @@ public @interface Query {
String maximum() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/minimum</code>.
+ * <mk>minimum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -237,7 +237,7 @@ public @interface Query {
String minimum() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/multipleOf</code>.
+ * <mk>multipleOf</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -251,7 +251,7 @@ public @interface Query {
String multipleOf() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/maxLength</code>.
+ * <mk>maxLength</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -265,7 +265,7 @@ public @interface Query {
String maxLength() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/minLength</code>.
+ * <mk>minLength</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -279,7 +279,7 @@ public @interface Query {
String minLength() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/maxItems</code>.
+ * <mk>maxItems</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -293,7 +293,7 @@ public @interface Query {
String maxItems() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/minItems</code>.
+ * <mk>minItems</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -307,7 +307,7 @@ public @interface Query {
String minItems() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/allowEmptyValue</code>.
+ * <mk>allowEmptyValue</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -321,7 +321,7 @@ public @interface Query {
String allowEmptyValue() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/exclusiveMaximum</code>.
+ * <mk>exclusiveMaximum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -335,7 +335,7 @@ public @interface Query {
String exclusiveMaximum() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/exclusiveMinimum</code>.
+ * <mk>exclusiveMinimum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -349,7 +349,7 @@ public @interface Query {
String exclusiveMinimum() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/uniqueItems</code>.
+ * <mk>uniqueItems</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -363,7 +363,7 @@ public @interface Query {
String uniqueItems() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/schema</code>.
+ * <mk>schema</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -385,7 +385,7 @@ public @interface Query {
Schema schema() default @Schema;
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/default</code>.
+ * <mk>default</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <p>
* Additionally, this method can be used to define a default value for
a missing query entry.
@@ -403,7 +403,7 @@ public @interface Query {
String[] _default() default {};
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/enum</code>.
+ * <mk>enum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -418,7 +418,7 @@ public @interface Query {
String[] _enum() default {};
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/items</code>.
+ * <mk>items</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -432,7 +432,7 @@ public @interface Query {
Items items() default @Items;
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#/x-example</code>.
+ * TODO
*
* <p>
* This attribute defines a JSON representation of the value that is
used by {@link BasicRestInfoProvider} to construct
@@ -451,7 +451,7 @@ public @interface Query {
String[] example() default {};
/**
- * Free-form value for the swagger field
<code>/paths/{path}/{method}/parameters(in=query)/#</code>
+ * Free-form value for the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#parameterObject";>Parameter</a>
object.
*
* <p>
* This is a JSON object that makes up the swagger information for this
field.
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 3e9cd77..a7512f4 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
@@ -115,7 +115,7 @@ public @interface Response {
int value() default 0;
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/description</code>.
+ * <mk>description</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#responseObject";>Response</a> object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -130,12 +130,12 @@ public @interface Response {
String[] description() default {};
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/schema</code>.
+ * <mk>schema</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#responseObject";>Response</a> object.
*/
Schema schema() default @Schema;
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers</code>.
+ * <mk>headers</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#responseObject";>Response</a> object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -157,7 +157,7 @@ public @interface Response {
ResponseHeader[] headers() default {};
/**
- * Used for populating the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/x-examples</code>.
+ * TODO
*
* <p>
* The format of the example should be a JSON representation of the
POJO being serialized.
@@ -184,7 +184,7 @@ public @interface Response {
String[] example() default {};
/**
- * Used for populating the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/examples</code>.
+ * TODO
*
* <p>
* The format is a JSON object with keys as media types and values as
string representations of the body response.
@@ -204,7 +204,7 @@ public @interface Response {
String[] examples() default {};
/**
- * Free-form value for the swagger field
<code>/paths/{path}/{method}/responses/{response}</code>
+ * Free-form value for the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#responseObject";>Response</a> object.
*
* <p>
* This is a JSON object that makes up the swagger information for this
field.
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 02b60a1..8ace2b3 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
@@ -140,7 +140,7 @@ public @interface ResponseHeader {
Class<? extends HttpPartSerializer> serializer() default
HttpPartSerializer.Null.class;
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/description</code>.
+ * <mk>description</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a> object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -155,7 +155,7 @@ public @interface ResponseHeader {
String[] description() default {};
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/type</code>.
+ * <mk>type</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a> object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -183,7 +183,7 @@ public @interface ResponseHeader {
String type() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/format</code>.
+ * <mk>format</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a> object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -202,7 +202,7 @@ public @interface ResponseHeader {
String format() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/collectionFormat</code>.
+ * <mk>collectionFormat</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a> object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -225,7 +225,7 @@ public @interface ResponseHeader {
String collectionFormat() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/$ref</code>.
+ * <mk>$ref</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a> object.
*
* <p>
* Denotes a reference to a definition object.
@@ -242,7 +242,7 @@ public @interface ResponseHeader {
String $ref() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/maximum</code>.
+ * <mk>maximum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a> object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -256,7 +256,7 @@ public @interface ResponseHeader {
String maximum() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/minimum</code>.
+ * <mk>minimum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a> object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -270,7 +270,7 @@ public @interface ResponseHeader {
String minimum() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/multipleOf</code>.
+ * <mk>multipleOf</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a> object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -284,7 +284,7 @@ public @interface ResponseHeader {
String multipleOf() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/maxLength</code>.
+ * <mk>maxLength</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a> object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -298,7 +298,7 @@ public @interface ResponseHeader {
String maxLength() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/minLength</code>.
+ * <mk>minLength</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a> object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -312,7 +312,7 @@ public @interface ResponseHeader {
String minLength() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/maxItems</code>.
+ * <mk>maxItems</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a> object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -326,7 +326,7 @@ public @interface ResponseHeader {
String maxItems() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/minItems</code>.
+ * <mk>minItems</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a> object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -340,7 +340,7 @@ public @interface ResponseHeader {
String minItems() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/exclusiveMaximum</code>.
+ * <mk>exclusiveMaximum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a> object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -354,7 +354,7 @@ public @interface ResponseHeader {
String exclusiveMaximum() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/exclusiveMinimum</code>.
+ * <mk>exclusiveMinimum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a> object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -368,7 +368,7 @@ public @interface ResponseHeader {
String exclusiveMinimum() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/uniqueItems</code>.
+ * <mk>uniqueItems</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a> object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -382,7 +382,7 @@ public @interface ResponseHeader {
String uniqueItems() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/items</code>.
+ * <mk>items</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a> object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -397,7 +397,7 @@ public @interface ResponseHeader {
Items items() default @Items;
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/default</code>.
+ * <mk>default</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a> object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -412,7 +412,7 @@ public @interface ResponseHeader {
String[] _default() default {};
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/enum</code>.
+ * <mk>enum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a> object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -427,7 +427,7 @@ public @interface ResponseHeader {
String[] _enum() default {};
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/headers/{header-name}/x-example</code>.
+ * TODO
*
* <p>
* This attribute defines a JSON representation of the body value that
is used by {@link BasicRestInfoProvider} to construct
@@ -446,7 +446,7 @@ public @interface ResponseHeader {
String[] example() default {};
/**
- * Free-form value for the swagger field
<code>/paths/{path}/{method}/responses/{response}/headers/{header}</code>
+ * Free-form value for the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#headerObject";>Header</a> object.
*
* <p>
* This is a JSON object that makes up the swagger information for this
Header object.
diff --git
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/ResponseStatus.java
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/ResponseStatus.java
index 0c817e4..95f03c8 100644
---
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/ResponseStatus.java
+++
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/ResponseStatus.java
@@ -121,7 +121,7 @@ public @interface ResponseStatus {
int value() default 0;
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/responses/{status-code}/description</code>.
+ * <mk>description</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#responseObject";>Response</a> object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -136,7 +136,7 @@ public @interface ResponseStatus {
String[] description() default {};
/**
- * Free-form value for the swagger field
<code>/paths/{path}/{method}/responses/{response}</code>
+ * Free-form value for the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#responseObject";>Response</a> object.
*
* <p>
* This is a JSON object that makes up the swagger information for this
Response object.
diff --git
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Schema.java
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Schema.java
index 07e1fa0..6c71ebd 100644
---
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Schema.java
+++
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Schema.java
@@ -40,7 +40,7 @@ import org.apache.juneau.rest.*;
public @interface Schema {
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/[parameters(in=body)|responses]/schema/$ref</code>.
+ * <mk>$ref</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a> object.
*
* <p>
* A JSON reference to the schema definition.
@@ -57,7 +57,7 @@ public @interface Schema {
String $ref() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/[parameters(in=body)|responses]/schema/format</code>.
+ * <mk>format</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a> object.
*
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
@@ -84,10 +84,22 @@ public @interface Schema {
*/
String format() default "";
+ /**
+ * <mk>title</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * 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>).
+ * </ul>
+ */
String title() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/[parameters(in=body)|responses]/schema/description</code>.
+ * <mk>description</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a> object.
*
* <p>
* A brief description of the body. This could contain examples of use.
@@ -124,7 +136,7 @@ public @interface Schema {
String[] description() default {};
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/[parameters(in=body)|responses]/schema/default</code>.
+ * <mk>default</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a> object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -139,7 +151,7 @@ public @interface Schema {
String[] _default() default {};
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/[parameters(in=body)|responses]/schema/multipleOf</code>.
+ * <mk>multipleOf</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a> object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -153,7 +165,7 @@ public @interface Schema {
String multipleOf() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/[parameters(in=body)|responses]/schema/maximum</code>.
+ * <mk>maximum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a> object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -167,7 +179,7 @@ public @interface Schema {
String maximum() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/[parameters(in=body)|responses]/schema/exclusiveMaximum</code>.
+ * <mk>exclusiveMaximum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a> object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -181,7 +193,7 @@ public @interface Schema {
String exclusiveMaximum() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/[parameters(in=body)|responses]/schema/minimum</code>.
+ * <mk>minimum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a> object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -195,7 +207,7 @@ public @interface Schema {
String minimum() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/[parameters(in=body)|responses]/schema/exclusiveMinimum</code>.
+ * <mk>exclusiveMinimum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a> object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -209,7 +221,7 @@ public @interface Schema {
String exclusiveMinimum() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/[parameters(in=body)|responses]/schema/maxLength</code>.
+ * <mk>maxLength</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a> object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -223,7 +235,7 @@ public @interface Schema {
String maxLength() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/[parameters(in=body)|responses]/schema/minLength</code>.
+ * <mk>minLength</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a> object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -237,7 +249,7 @@ public @interface Schema {
String minLength() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/[parameters(in=body)|responses]/schema/pattern</code>.
+ * <mk>pattern</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a> object.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -259,7 +271,7 @@ public @interface Schema {
String pattern() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/[parameters(in=body)|responses]/schema/maxItems</code>.
+ * <mk>maxItems</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a> object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -273,7 +285,7 @@ public @interface Schema {
String maxItems() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/[parameters(in=body)|responses]/schema/minItems</code>.
+ * <mk>minItems</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a> object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -287,7 +299,7 @@ public @interface Schema {
String minItems() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/[parameters(in=body)|responses]/schema/uniqueItems</code>.
+ * <mk>uniqueItems</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a> object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -300,12 +312,40 @@ public @interface Schema {
*/
String uniqueItems() default "";
+
+ /**
+ * <mk>maxProperties</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * 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>
+ * (e.g. <js>"$L{my.localized.variable}"</js>).
+ * </ul>
+ */
String maxProperties() default "";
+
+ /**
+ * <mk>minProperties</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * 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>
+ * (e.g. <js>"$L{my.localized.variable}"</js>).
+ * </ul>
+ */
String minProperties() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/[parameters(in=body)|responses]/schema/required</code>.
+ * <mk>required</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a> object.
*
* <p>
* Determines whether this parameter is mandatory.
@@ -340,7 +380,7 @@ public @interface Schema {
String required() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/[parameters(in=body)|responses]/schema/enum</code>.
+ * <mk>enum</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a> object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -355,7 +395,7 @@ public @interface Schema {
String[] _enum() default {};
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/[parameters(in=body)|responses]/schema/type</code>.
+ * <mk>type</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a> object.
*
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
@@ -403,7 +443,7 @@ public @interface Schema {
String type() default "";
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/[parameters(in=body)|responses]/schema/items</code>.
+ * <mk>items</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a> object.
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -417,20 +457,113 @@ public @interface Schema {
*/
Items items() default @Items;
+ /**
+ * <mk>allOf</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * 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>
+ * (e.g. <js>"$L{my.localized.variable}"</js>).
+ * </ul>
+ */
String[] allOf() default {};
+
+ /**
+ * <mk>properties</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * 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>
+ * (e.g. <js>"$L{my.localized.variable}"</js>).
+ * </ul>
+ */
String[] properties() default {};
+
+ /**
+ * <mk>additionalProperties</mk> field of the Swagger <a
class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * 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>
+ * (e.g. <js>"$L{my.localized.variable}"</js>).
+ * </ul>
+ */
String[] additionalProperties() default {};
-// discriminator string Adds support for polymorphism. The
discriminator is the schema property name that is used to differentiate between
other schema that inherit this schema. The property name used MUST be defined
at this schema and it MUST be in the required property list. When used, the
value MUST be the name of this schema or any schema that inherits it.
+
+ /**
+ * <mk>discriminator</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * 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>
+ * (e.g. <js>"$L{my.localized.variable}"</js>).
+ * </ul>
+ */
String discriminator() default "";
-// readOnly boolean Relevant only for Schema "properties"
definitions. Declares the property as "read only". This means that it MAY be
sent as part of a response but MUST NOT be sent as part of the request.
Properties marked as readOnly being true SHOULD NOT be in the required list of
the defined schema. Default value is false.
+
+ /**
+ * <mk>readOnly</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * 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>
+ * (e.g. <js>"$L{my.localized.variable}"</js>).
+ * </ul>
+ */
String readOnly() default "";
-// xml XML Object This MAY be used only on properties schemas. It
has no effect on root schemas. Adds Additional metadata to describe the XML
representation format of this property.
+
+ /**
+ * <mk>xml</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * 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>
+ * (e.g. <js>"$L{my.localized.variable}"</js>).
+ * </ul>
+ */
String[] xml() default {};
-// externalDocs External Documentation Object Additional external
documentation for this schema.
+
+ /**
+ * <mk>externalDocs</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * 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>
+ * (e.g. <js>"$L{my.localized.variable}"</js>).
+ * </ul>
+ */
ExternalDocs externalDocs() default @ExternalDocs;
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/[parameters(in=body)|responses]/schema/example</code>.
+ * TODO
*
* <p>
* This attribute defines a JSON representation of the body value that
is used by {@link BasicRestInfoProvider} to construct
@@ -449,7 +582,7 @@ public @interface Schema {
String[] example() default {};
/**
- * Defines the swagger field
<code>/paths/{path}/{method}/[parameters(in=body)|responses]/schema/x-examples</code>.
+ * TODO
*
* <p>
* This is a JSON object whose keys are media types and values are
string representations of that value.
@@ -469,7 +602,7 @@ public @interface Schema {
boolean ignore() default false;
/**
- * Free-form value for Schema objects in Swagger
+ * Free-form value for the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#schemaObject";>Schema</a> object.
*
* <p>
* This is a JSON object that makes up the swagger information for this
field.
diff --git
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Tag.java
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Tag.java
index beeb2e1..85a9c2a 100644
---
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Tag.java
+++
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Tag.java
@@ -37,13 +37,55 @@ import java.lang.annotation.*;
@Inherited
public @interface Tag {
+ /**
+ * <mk>name</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#tagObject";>Tag</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * 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>
+ * (e.g. <js>"$L{my.localized.variable}"</js>).
+ * </ul>
+ */
String name() default "";
+
String value() default "";
+
+ /**
+ * <mk>description</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#tagObject";>Tag</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * 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>
+ * (e.g. <js>"$L{my.localized.variable}"</js>).
+ * </ul>
+ */
String[] description() default {};
+
+ /**
+ * <mk>externalDocs</mk> field of the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#tagObject";>Tag</a> object.
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>
+ * 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>
+ * (e.g. <js>"$L{my.localized.variable}"</js>).
+ * </ul>
+ */
ExternalDocs externalDocs() default @ExternalDocs;
/**
- * Free-form value for the swagger field <code>/tags/[#]</code>
+ * Free-form value for the Swagger <a class="doclink"
href="https://swagger.io/specification/v2/#tagObject";>Tag</a> object.
*
* <p>
* This is a JSON object that makes up the swagger information for this
Tag object.
--
To stop receiving notification emails like this one, please contact
[email protected].
