You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2018/01/14 16:02:53 UTC
[25/32] juneau git commit: Javadoc updates.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java
index 89004f9..01055c1 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java
@@ -21,10 +21,10 @@ import org.apache.juneau.annotation.*;
/**
* Describes a single operation parameter.
- *
+ *
* <p>
* A unique parameter is defined by a combination of a name and location.
- *
+ *
* <p>
* There are five possible parameter types.
* <ul>
@@ -62,7 +62,7 @@ import org.apache.juneau.annotation.*;
* </ul>
* </li>
* </ul>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -117,10 +117,10 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>name</property>.
- *
+ *
* <p>
* Required. The name of the parameter.
- *
+ *
* <p>
* Parameter names are case sensitive.
* If <code>in</code> is <js>"path"</js>, the <code>name</code> field MUST correspond to the associated path segment
@@ -129,7 +129,7 @@ public class ParameterInfo extends SwaggerElement {
* See <a class="doclink" href="http://swagger.io/specification/#pathTemplating">Path Templating</a> for further
* information.
* For all other cases, the name corresponds to the parameter name used based on the <code>in</code> property.
- *
+ *
* @return The value of the <property>name</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getName() {
@@ -138,10 +138,10 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>name</property>.
- *
+ *
* <p>
* Required. The name of the parameter.
- *
+ *
* <p>
* Parameter names are case sensitive.
* If <code>in</code> is <js>"path"</js>, the <code>name</code> field MUST correspond to the associated path segment
@@ -150,7 +150,7 @@ public class ParameterInfo extends SwaggerElement {
* See <a class="doclink" href="http://swagger.io/specification/#pathTemplating">Path Templating</a> for further
* information.
* For all other cases, the name corresponds to the parameter name used based on the <code>in</code> property.
- *
+ *
* @param name The new value for the <property>name</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -162,7 +162,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setName(String)}.
- *
+ *
* @param name The new value for the <property>name</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -172,13 +172,13 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>in</property>.
- *
+ *
* <p>
* Required. The location of the parameter.
- *
+ *
* <p>
* Possible values are <js>"query"</js>, <js>"header"</js>, <js>"path"</js>, <js>"formData"</js> or <js>"body"</js>.
- *
+ *
* @return The value of the <property>in</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getIn() {
@@ -187,13 +187,13 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>in</property>.
- *
+ *
* <p>
* Required. The location of the parameter.
- *
+ *
* <p>
* Possible values are <js>"query"</js>, <js>"header"</js>, <js>"path"</js>, <js>"formData"</js> or <js>"body"</js>.
- *
+ *
* @param in The new value for the <property>in</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -211,7 +211,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setIn(String)}.
- *
+ *
* @param in The new value for the <property>in</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -221,15 +221,15 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>description</property>.
- *
+ *
* <p>
* A brief description of the parameter.
- *
+ *
* <p>
* This could contain examples of use.
* <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
* for rich text representation.
- *
+ *
* @return
* The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -239,15 +239,15 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>description</property>.
- *
+ *
* <p>
* A brief description of the parameter.
- *
+ *
* <p>
* This could contain examples of use.
* <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
* for rich text representation.
- *
+ *
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -258,7 +258,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setDescription(String)}.
- *
+ *
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -268,15 +268,15 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>required</property>.
- *
+ *
* <p>
* Determines whether this parameter is mandatory.
- *
+ *
* <p>
* If the parameter is <code>in</code> <js>"path"</js>, this property is required and its value MUST be
* <jk>true</jk>.
* Otherwise, the property MAY be included and its default value is <jk>false</jk>.
- *
+ *
* @return The value of the <property>required</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Boolean getRequired() {
@@ -285,15 +285,15 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>required</property>.
- *
+ *
* <p>
* Determines whether this parameter is mandatory.
- *
+ *
* <p>
* If the parameter is <code>in</code> <js>"path"</js>, this property is required and its value MUST be
* <jk>true</jk>.
* Otherwise, the property MAY be included and its default value is <jk>false</jk>.
- *
+ *
* @param required The new value for the <property>required</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -304,7 +304,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setRequired(Boolean)}.
- *
+ *
* @param required The new value for the <property>required</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -314,10 +314,10 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>schema</property>.
- *
+ *
* <p>
* Required. The schema defining the type used for the body parameter.
- *
+ *
* @return The value of the <property>schema</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public SchemaInfo getSchema() {
@@ -326,10 +326,10 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>schema</property>.
- *
+ *
* <p>
* Required. The schema defining the type used for the body parameter.
- *
+ *
* @param schema The new value for the <property>schema</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -340,7 +340,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setSchema(SchemaInfo)}.
- *
+ *
* @param schema The new value for the <property>schema</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -350,10 +350,10 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>type</property>.
- *
+ *
* <p>
* Required. The type of the parameter.
- *
+ *
* <p>
* Since the parameter is not located at the request body, it is limited to simple types (that is, not an object).
* The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>,
@@ -361,7 +361,7 @@ public class ParameterInfo extends SwaggerElement {
* If type is <js>"file"</js>, the <code>consumes</code> MUST be either <js>"multipart/form-data"</js>,
* <js>"application/x-www-form-urlencoded"</js> or both and the parameter MUST be <code>in</code>
* <js>"formData"</js>.
- *
+ *
* @return The value of the <property>type</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getType() {
@@ -370,10 +370,10 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>type</property>.
- *
+ *
* <p>
* Required. The type of the parameter.
- *
+ *
* <p>
* Since the parameter is not located at the request body, it is limited to simple types (that is, not an object).
* The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>,
@@ -381,7 +381,7 @@ public class ParameterInfo extends SwaggerElement {
* If type is <js>"file"</js>, the <code>consumes</code> MUST be either <js>"multipart/form-data"</js>,
* <js>"application/x-www-form-urlencoded"</js> or both and the parameter MUST be <code>in</code>
* <js>"formData"</js>.
- *
+ *
* @param type The new value for the <property>type</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -397,7 +397,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setType(String)}.
- *
+ *
* @param type The new value for the <property>type</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -407,14 +407,14 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>format</property>.
- *
+ *
* <p>
* The extending format for the previously mentioned type.
- *
+ *
* <p>
* See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further
* details.
- *
+ *
* @return The value of the <property>format</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getFormat() {
@@ -423,14 +423,14 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>format</property>.
- *
+ *
* <p>
* The extending format for the previously mentioned type.
- *
+ *
* <p>
* See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further
* details.
- *
+ *
* @param format The new value for the <property>format</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -441,7 +441,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setFormat(String)}.
- *
+ *
* @param format The new value for the <property>format</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -451,15 +451,15 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>allowEmptyValue</property>.
- *
+ *
* <p>
* Sets the ability to pass empty-valued parameters.
- *
+ *
* <p>
* This is valid only for either <code>query</code> or <code>formData</code> parameters and allows you to send a
* parameter with a name only or an empty value.
* Default value is <jk>false</jk>.
- *
+ *
* @return The value of the <property>allowEmptyValue</property> property on this bean, or <jk>null</jk> if it is
* not set.
*/
@@ -469,15 +469,15 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>allowEmptyValue</property>.
- *
+ *
* <p>
* Sets the ability to pass empty-valued parameters.
- *
+ *
* <p>
* This is valid only for either <code>query</code> or <code>formData</code> parameters and allows you to send a
* parameter with a name only or an empty value.
* Default value is <jk>false</jk>.
- *
+ *
* @param allowEmptyValue The new value for the <property>allowEmptyValue</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -488,7 +488,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setAllowEmptyValue(Boolean)}.
- *
+ *
* @param allowEmptyValue The new value for the <property>allowEmptyValue</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -498,13 +498,13 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>items</property>.
- *
+ *
* <p>
* Required if <code>type</code> is <js>"array"</js>.
- *
+ *
* <p>
* Describes the type of items in the array.
- *
+ *
* @return The value of the <property>items</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Items getItems() {
@@ -513,13 +513,13 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>items</property>.
- *
+ *
* <p>
* Required if <code>type</code> is <js>"array"</js>.
- *
+ *
* <p>
* Describes the type of items in the array.
- *
+ *
* @param items The new value for the <property>items</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -530,7 +530,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setItems(Items)}.
- *
+ *
* @param items The new value for the <property>items</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -540,10 +540,10 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>collectionFormat</property>.
- *
+ *
* <p>
* Determines the format of the array if type array is used.
- *
+ *
* <p>
* Possible values are:
* <ul>
@@ -555,10 +555,10 @@ public class ParameterInfo extends SwaggerElement {
* instance <code>foo=bar&foo=baz</code>.
* This is valid only for parameters <code>in</code> <js>"query"</js> or <js>"formData"</js>.
* </ul>
- *
+ *
* <p>
* Default value is <code>csv</code>.
- *
+ *
* @return
* The value of the <property>collectionFormat</property> property on this bean, or <jk>null</jk> if it is
* not set.
@@ -569,10 +569,10 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>collectionFormat</property>.
- *
+ *
* <p>
* Determines the format of the array if type array is used.
- *
+ *
* <p>
* Possible values are:
* <ul>
@@ -584,10 +584,10 @@ public class ParameterInfo extends SwaggerElement {
* instance <code>foo=bar&foo=baz</code>.
* This is valid only for parameters <code>in</code> <js>"query"</js> or <js>"formData"</js>.
* </ul>
- *
+ *
* <p>
* Default value is <code>csv</code>.
- *
+ *
* @param collectionFormat The new value for the <property>collectionFormat</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -603,7 +603,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setCollectionFormat(String)}.
- *
+ *
* @param collectionFormat The new value for the <property>collectionFormat</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -613,7 +613,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>default</property>.
- *
+ *
* <p>
* Declares the value of the parameter that the server will use if none is provided, for example a <js>"count"</js>
* to control the number of results per page might default to 100 if not supplied by the client in the request.
@@ -621,7 +621,7 @@ public class ParameterInfo extends SwaggerElement {
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor101">
* http://json-schema.org/latest/json-schema-validation.html#anchor101</a>.
* Unlike JSON Schema this value MUST conform to the defined <code>type</code> for this parameter.
- *
+ *
* @return The value of the <property>default</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Object getDefault() {
@@ -630,7 +630,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>default</property>.
- *
+ *
* <p>
* Declares the value of the parameter that the server will use if none is provided, for example a <js>"count"</js>
* to control the number of results per page might default to 100 if not supplied by the client in the request.
@@ -638,7 +638,7 @@ public class ParameterInfo extends SwaggerElement {
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor101">
* http://json-schema.org/latest/json-schema-validation.html#anchor101</a>.
* Unlike JSON Schema this value MUST conform to the defined <code>type</code> for this parameter.
- *
+ *
* @param _default The new value for the <property>default</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -649,7 +649,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setDefault(Object)}.
- *
+ *
* @param _default The new value for the <property>default</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -659,11 +659,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>maximum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">
* http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
- *
+ *
* @return The value of the <property>maximum</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Number getMaximum() {
@@ -672,11 +672,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>maximum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">
* http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
- *
+ *
* @param maximum The new value for the <property>maximum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -687,7 +687,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setMaximum(Number)}.
- *
+ *
* @param maximum The new value for the <property>maximum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -697,11 +697,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>exclusiveMaximum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">
* http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
- *
+ *
* @return The value of the <property>exclusiveMaximum</property> property on this bean, or <jk>null</jk>
* if it is not set.
*/
@@ -711,11 +711,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>exclusiveMaximum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">
* http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
- *
+ *
* @param exclusiveMaximum The new value for the <property>exclusiveMaximum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -726,7 +726,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setExclusiveMaximum(Boolean)}.
- *
+ *
* @param exclusiveMaximum The new value for the <property>exclusiveMaximum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -736,11 +736,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>minimum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">
* http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
- *
+ *
* @return The value of the <property>minimum</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Number getMinimum() {
@@ -749,11 +749,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>minimum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">
* http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
- *
+ *
* @param minimum The new value for the <property>minimum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -764,7 +764,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setMinimum(Number)}.
- *
+ *
* @param minimum The new value for the <property>minimum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -774,11 +774,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>exclusiveMinimum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">
* http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
- *
+ *
* @return The value of the <property>exclusiveMinimum</property> property on this bean, or <jk>null</jk> if it is
* not set.
*/
@@ -788,11 +788,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>exclusiveMinimum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">
* http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
- *
+ *
* @param exclusiveMinimum The new value for the <property>exclusiveMinimum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -803,7 +803,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setExclusiveMinimum(Boolean)}.
- *
+ *
* @param exclusiveMinimum The new value for the <property>exclusiveMinimum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -813,11 +813,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>maxLength</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor26">
* http://json-schema.org/latest/json-schema-validation.html#anchor26</a>.
- *
+ *
* @return The value of the <property>maxLength</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Integer getMaxLength() {
@@ -826,11 +826,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>maxLength</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor26">
* http://json-schema.org/latest/json-schema-validation.html#anchor26</a>.
- *
+ *
* @param maxLength The new value for the <property>maxLength</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -841,7 +841,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setMaxLength(Integer)}.
- *
+ *
* @param maxLength The new value for the <property>maxLength</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -851,11 +851,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>minLength</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor29">
* http://json-schema.org/latest/json-schema-validation.html#anchor29</a>.
- *
+ *
* @return The value of the <property>minLength</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Integer getMinLength() {
@@ -864,11 +864,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>minLength</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor29">
* http://json-schema.org/latest/json-schema-validation.html#anchor29</a>.
- *
+ *
* @param minLength The new value for the <property>minLength</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -879,7 +879,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setMinLength(Integer)}.
- *
+ *
* @param minLength The new value for the <property>minLength</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -889,11 +889,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>pattern</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor33">
* http://json-schema.org/latest/json-schema-validation.html#anchor33</a>.
- *
+ *
* @return The value of the <property>pattern</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getPattern() {
@@ -902,11 +902,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>pattern</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor33">
* http://json-schema.org/latest/json-schema-validation.html#anchor33</a>.
- *
+ *
* @param pattern The new value for the <property>pattern</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -917,7 +917,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setPattern(String)}.
- *
+ *
* @param pattern The new value for the <property>pattern</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -927,11 +927,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>maxItems</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor42">
* http://json-schema.org/latest/json-schema-validation.html#anchor42</a>.
- *
+ *
* @return The value of the <property>maxItems</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Integer getMaxItems() {
@@ -940,11 +940,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>maxItems</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor42">
* http://json-schema.org/latest/json-schema-validation.html#anchor42</a>.
- *
+ *
* @param maxItems The new value for the <property>maxItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -955,7 +955,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setMaxItems(Integer)}.
- *
+ *
* @param maxItems The new value for the <property>maxItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -965,11 +965,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>minItems</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor45">
* http://json-schema.org/latest/json-schema-validation.html#anchor45</a>.
- *
+ *
* @return The value of the <property>minItems</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Integer getMinItems() {
@@ -978,11 +978,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>minItems</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor45">
* http://json-schema.org/latest/json-schema-validation.html#anchor45</a>.
- *
+ *
* @param minItems The new value for the <property>minItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -993,7 +993,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setMinItems(Integer)}.
- *
+ *
* @param minItems The new value for the <property>minItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -1003,11 +1003,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>uniqueItems</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor49">
* http://json-schema.org/latest/json-schema-validation.html#anchor49</a>.
- *
+ *
* @return The value of the <property>uniqueItems</property> property on this bean, or <jk>null</jk> if it is not
* set.
*/
@@ -1017,11 +1017,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>uniqueItems</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor49">
* http://json-schema.org/latest/json-schema-validation.html#anchor49</a>.
- *
+ *
* @param uniqueItems The new value for the <property>uniqueItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -1032,7 +1032,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setUniqueItems(Boolean)}.
- *
+ *
* @param uniqueItems The new value for the <property>uniqueItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -1042,11 +1042,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>enum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">
* http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
- *
+ *
* @return The value of the <property>enum</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public List<Object> getEnum() {
@@ -1055,11 +1055,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>enum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">
* http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
- *
+ *
* @param _enum The new value for the <property>enum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -1070,11 +1070,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property adder: <property>enum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">
* http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
- *
+ *
* @param _enum
* The new values to add to the <property>enum</property> property on this bean.
* These can either be individual objects or {@link Collection Collections} of objects.
@@ -1098,7 +1098,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #addEnum(Object...)}.
- *
+ *
* @param _enum
* The new values to add to the <property>enum</property> property on this bean.
* These can either be individual objects or {@link Collection Collections} of objects.
@@ -1110,11 +1110,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>multipleOf</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor14">
* http://json-schema.org/latest/json-schema-validation.html#anchor14</a>.
- *
+ *
* @return The value of the <property>multipleOf</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Number getMultipleOf() {
@@ -1123,11 +1123,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>multipleOf</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor14">
* http://json-schema.org/latest/json-schema-validation.html#anchor14</a>.
- *
+ *
* @param multipleOf The new value for the <property>multipleOf</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -1138,7 +1138,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setMultipleOf(Number)}.
- *
+ *
* @param multipleOf The new value for the <property>multipleOf</property> property on this bean.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/ResponseInfo.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/ResponseInfo.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/ResponseInfo.java
index 71461a3..ddcba7f 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/ResponseInfo.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/ResponseInfo.java
@@ -18,7 +18,7 @@ import org.apache.juneau.annotation.*;
/**
* Describes a single response from an API Operation.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* {
@@ -31,7 +31,7 @@ import org.apache.juneau.annotation.*;
* }
* }
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -57,14 +57,14 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property getter: <property>description</property>.
- *
+ *
* <p>
* Required. A short description of the response.
- *
+ *
* <p>
* <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used for
* rich text representation.
- *
+ *
* @return The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getDescription() {
@@ -73,14 +73,14 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property setter: <property>description</property>.
- *
+ *
* <p>
* Required. A short description of the response.
- *
+ *
* <p>
* <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
* for rich text representation.
- *
+ *
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -91,7 +91,7 @@ public class ResponseInfo extends SwaggerElement {
/**
* Synonym for {@link #setDescription(String)}.
- *
+ *
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -101,17 +101,17 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property getter: <property>schema</property>.
- *
+ *
* <p>
* A definition of the response structure.
- *
+ *
* <p>
* It can be a primitive, an array or an object.
* If this field does not exist, it means no content is returned as part of the response.
* As an extension to the <a class="doclink" href="http://swagger.io/specification/#schemaObject">Schema Object</a>,
* its root type value may also be <js>"file"</js>.
* This SHOULD be accompanied by a relevant produces mime-type.
- *
+ *
* @return The value of the <property>schema</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public SchemaInfo getSchema() {
@@ -120,17 +120,17 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property setter: <property>schema</property>.
- *
+ *
* <p>
* A definition of the response structure.
- *
+ *
* <p>
* It can be a primitive, an array or an object.
* If this field does not exist, it means no content is returned as part of the response.
* As an extension to the <a class="doclink" href="http://swagger.io/specification/#schemaObject">Schema Object</a>,
* its root type value may also be <js>"file"</js>.
* This SHOULD be accompanied by a relevant produces mime-type.
- *
+ *
* @param schema The new value for the <property>schema</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -141,7 +141,7 @@ public class ResponseInfo extends SwaggerElement {
/**
* Synonym for {@link #setSchema(SchemaInfo)}.
- *
+ *
* @param schema The new value for the <property>schema</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -151,10 +151,10 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property getter: <property>headers</property>.
- *
+ *
* <p>
* A list of headers that are sent with the response.
- *
+ *
* @return The value of the <property>headers</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Map<String,HeaderInfo> getHeaders() {
@@ -163,10 +163,10 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property setter: <property>headers</property>.
- *
+ *
* <p>
* A list of headers that are sent with the response.
- *
+ *
* @param headers The new value for the <property>headers</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -177,10 +177,10 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property adder: <property>headers</property>.
- *
+ *
* <p>
* A list of headers that are sent with the response.
- *
+ *
* @param name The header name.
* @param header The header descriptions
* @return This object (for method chaining).
@@ -194,7 +194,7 @@ public class ResponseInfo extends SwaggerElement {
/**
* Synonym for {@link #addHeader(String,HeaderInfo)}.
- *
+ *
* @param name The header name.
* @param header The header descriptions
* @return This object (for method chaining).
@@ -205,13 +205,13 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property getter: <property>examples</property>.
- *
+ *
* <p>
* An example of the response message.
- *
+ *
* <p>
* Keys must be MIME-type strings.
- *
+ *
* @return The value of the <property>examples</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Map<String,Object> getExamples() {
@@ -220,13 +220,13 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property setter: <property>examples</property>.
- *
+ *
* <p>
* An example of the response message.
- *
+ *
* <p>
* Keys must be MIME-type strings.
- *
+ *
* @param examples The new value for the <property>examples</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -237,10 +237,10 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property adder: <property>examples</property>.
- *
+ *
* <p>
* An example of the response message.
- *
+ *
* @param mimeType The mimeType of the example.
* @param example The example output.
* @return This object (for method chaining).
@@ -254,7 +254,7 @@ public class ResponseInfo extends SwaggerElement {
/**
* Synonym for {@link #addExample(String,Object)}.
- *
+ *
* @param mimeType The mimeType of the example.
* @param example The example output.
* @return This object (for method chaining).
@@ -265,7 +265,7 @@ public class ResponseInfo extends SwaggerElement {
/**
* Synonym for {@link #setExamples(Map)}.
- *
+ *
* @param examples The new value for the <property>examples</property> property on this bean.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java
index a2bc4c1..fe27eba 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java
@@ -18,16 +18,16 @@ import org.apache.juneau.annotation.*;
/**
* The Schema Object allows the definition of input and output data types.
- *
+ *
* <p>
* These types can be objects, but also primitives and arrays.
* This object is based on the JSON Schema Specification Draft 4 and uses a predefined subset of it.
* On top of this subset, there are extensions provided by this specification to allow for more complete documentation.
- *
+ *
* <p>
* Further information about the properties can be found in JSON Schema Core and JSON Schema Validation.
* Unless stated otherwise, the property definitions follow the JSON Schema specification as referenced here.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -79,11 +79,11 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>format</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further
* details.
- *
+ *
* @return The value of the <property>format</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getFormat() {
@@ -92,11 +92,11 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>format</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further
* details.
- *
+ *
* @param format The new value for the <property>format</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -107,7 +107,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setFormat(String)}.
- *
+ *
* @param format The new value for the <property>format</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -117,7 +117,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>title</property>.
- *
+ *
* @return The value of the <property>title</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getTitle() {
@@ -126,7 +126,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>title</property>.
- *
+ *
* @param title The new value for the <property>title</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -137,7 +137,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setTitle(String)}.
- *
+ *
* @param title The new value for the <property>title</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -147,11 +147,11 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>description</property>.
- *
+ *
* <p>
* <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
* for rich text representation.
- *
+ *
* @return The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getDescription() {
@@ -160,11 +160,11 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>description</property>.
- *
+ *
* <p>
* <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
* for rich text representation.
- *
+ *
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -175,7 +175,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setDescription(String)}.
- *
+ *
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -185,10 +185,10 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>default</property>.
- *
+ *
* <p>
* Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object.
- *
+ *
* @return The value of the <property>default</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Object getDefault() {
@@ -197,10 +197,10 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>default</property>.
- *
+ *
* <p>
* Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object.
- *
+ *
* @param _default The new value for the <property>default</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -211,7 +211,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setDefault(Object)}.
- *
+ *
* @param _default The new value for the <property>default</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -221,7 +221,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>multipleOf</property>.
- *
+ *
* @return The value of the <property>multipleOf</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Number getMultipleOf() {
@@ -230,7 +230,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>multipleOf</property>.
- *
+ *
* @param multipleOf The new value for the <property>multipleOf</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -241,7 +241,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setMultipleOf(Number)}.
- *
+ *
* @param multipleOf The new value for the <property>multipleOf</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -251,7 +251,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>maximum</property>.
- *
+ *
* @return The value of the <property>maximum</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Number getMaximum() {
@@ -260,7 +260,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>maximum</property>.
- *
+ *
* @param maximum The new value for the <property>maximum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -271,7 +271,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setMaximum(Number)}.
- *
+ *
* @param maximum The new value for the <property>maximum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -281,7 +281,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>exclusiveMaximum</property>.
- *
+ *
* @return
* The value of the <property>exclusiveMaximum</property> property on this bean, or <jk>null</jk> if it is
* not set.
@@ -292,7 +292,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>exclusiveMaximum</property>.
- *
+ *
* @param exclusiveMaximum The new value for the <property>exclusiveMaximum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -303,7 +303,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setExclusiveMaximum(Boolean)}.
- *
+ *
* @param exclusiveMaximum The new value for the <property>exclusiveMaximum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -313,7 +313,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>minimum</property>.
- *
+ *
* @return The value of the <property>minimum</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Number getMinimum() {
@@ -322,7 +322,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>minimum</property>.
- *
+ *
* @param minimum The new value for the <property>minimum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -333,7 +333,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setMinimum(Number)}.
- *
+ *
* @param minimum The new value for the <property>minimum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -343,7 +343,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>exclusiveMinimum</property>.
- *
+ *
* @return
* The value of the <property>exclusiveMinimum</property> property on this bean, or <jk>null</jk> if it is
* not set.
@@ -354,7 +354,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>exclusiveMinimum</property>.
- *
+ *
* @param exclusiveMinimum The new value for the <property>exclusiveMinimum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -365,7 +365,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setExclusiveMinimum(Boolean)}.
- *
+ *
* @param exclusiveMinimum The new value for the <property>exclusiveMinimum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -375,7 +375,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>maxLength</property>.
- *
+ *
* @return The value of the <property>maxLength</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Integer getMaxLength() {
@@ -384,7 +384,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>maxLength</property>.
- *
+ *
* @param maxLength The new value for the <property>maxLength</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -395,7 +395,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setMaxLength(Integer)}.
- *
+ *
* @param maxLength The new value for the <property>maxLength</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -405,7 +405,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>minLength</property>.
- *
+ *
* @return The value of the <property>minLength</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Integer getMinLength() {
@@ -414,7 +414,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>minLength</property>.
- *
+ *
* @param minLength The new value for the <property>minLength</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -425,7 +425,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setMinLength(Integer)}.
- *
+ *
* @param minLength The new value for the <property>minLength</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -435,7 +435,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>pattern</property>.
- *
+ *
* @return The value of the <property>pattern</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getPattern() {
@@ -444,7 +444,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>pattern</property>.
- *
+ *
* @param pattern The new value for the <property>pattern</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -455,7 +455,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setPattern(String)}.
- *
+ *
* @param pattern The new value for the <property>pattern</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -465,7 +465,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>maxItems</property>.
- *
+ *
* @return The value of the <property>maxItems</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Integer getMaxItems() {
@@ -474,7 +474,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>maxItems</property>.
- *
+ *
* @param maxItems The new value for the <property>maxItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -485,7 +485,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setMaxItems(Integer)}.
- *
+ *
* @param maxItems The new value for the <property>maxItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -495,7 +495,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>minItems</property>.
- *
+ *
* @return The value of the <property>minItems</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Integer getMinItems() {
@@ -504,7 +504,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>minItems</property>.
- *
+ *
* @param minItems The new value for the <property>minItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -515,7 +515,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setMinItems(Integer)}.
- *
+ *
* @param minItems The new value for the <property>minItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -525,7 +525,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>uniqueItems</property>.
- *
+ *
* @return The value of the <property>uniqueItems</property> property on this bean, or <jk>null</jk> if it is not
* set.
*/
@@ -534,7 +534,7 @@ public class SchemaInfo extends SwaggerElement {
}
/**
* Bean property setter: <property>uniqueItems</property>.
- *
+ *
* @param uniqueItems The new value for the <property>uniqueItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -545,7 +545,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setUniqueItems(Boolean)}.
- *
+ *
* @param uniqueItems The new value for the <property>uniqueItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -555,7 +555,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>maxProperties</property>.
- *
+ *
* @return The value of the <property>maxProperties</property> property on this bean, or <jk>null</jk> if it is
* not set.
*/
@@ -565,7 +565,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>maxProperties</property>.
- *
+ *
* @param maxProperties The new value for the <property>maxProperties</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -576,7 +576,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setMaxProperties(Integer)}.
- *
+ *
* @param maxProperties The new value for the <property>maxProperties</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -586,7 +586,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>minProperties</property>.
- *
+ *
* @return The value of the <property>minProperties</property> property on this bean, or <jk>null</jk> if it is
* not set.
*/
@@ -596,7 +596,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>minProperties</property>.
- *
+ *
* @param minProperties The new value for the <property>minProperties</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -607,7 +607,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setMinProperties(Integer)}.
- *
+ *
* @param minProperties The new value for the <property>minProperties</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -617,7 +617,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>required</property>.
- *
+ *
* @return The value of the <property>required</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Boolean getRequired() {
@@ -626,7 +626,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>required</property>.
- *
+ *
* @param required The new value for the <property>required</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -637,7 +637,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setRequired(Boolean)}.
- *
+ *
* @param required The new value for the <property>required</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -647,7 +647,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>enum</property>.
- *
+ *
* @return The value of the <property>enum</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public List<Object> getEnum() {
@@ -656,7 +656,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>enum</property>.
- *
+ *
* @param _enum The new value for the <property>enum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -667,7 +667,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property adder: <property>enum</property>.
- *
+ *
* @param _enum The new values to add to the <property>enum</property> property on this bean.
* These can either be individual objects or {@link Collection Collections} of objects.
* @return This object (for method chaining).
@@ -689,7 +689,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #addEnum(Object...)}.
- *
+ *
* @param _enum
* The new values to add to the <property>enum</property> property on this bean.
* These can either be individual objects or {@link Collection Collections} of objects.
@@ -701,7 +701,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>type</property>.
- *
+ *
* @return The value of the <property>type</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getType() {
@@ -710,7 +710,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>type</property>.
- *
+ *
* @param type The new value for the <property>type</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -721,7 +721,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setType(String)}.
- *
+ *
* @param type The new value for the <property>type</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -731,7 +731,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>items</property>.
- *
+ *
* @return The value of the <property>items</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Items getItems() {
@@ -740,7 +740,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>items</property>.
- *
+ *
* @param items The new value for the <property>items</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -751,7 +751,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setItems(Items)}.
- *
+ *
* @param items The new value for the <property>items</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -761,7 +761,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>allOf</property>.
- *
+ *
* @return The value of the <property>allOf</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public List<Object> getAllOf() {
@@ -770,7 +770,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>allOf</property>.
- *
+ *
* @param allOf The new value for the <property>allOf</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -781,7 +781,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property adder: <property>enum</property>.
- *
+ *
* @param allOf
* The new values to add to the <property>allOf</property> property on this bean.
* These can either be individual objects or {@link Collection Collections} of objects.
@@ -804,7 +804,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #addAllOf(Object...)}.
- *
+ *
* @param allOf
* The new values to add to the <property>allOf</property> property on this bean.
* These can either be individual objects or {@link Collection Collections} of objects.
@@ -816,7 +816,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>properties</property>.
- *
+ *
* @return The value of the <property>properties</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Map<String,Map<String,Object>> getProperties() {
@@ -825,7 +825,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>properties</property>.
- *
+ *
* @param properties The new value for the <property>properties</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -836,7 +836,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>properties</property>.
- *
+ *
* @param name The property name.
* @param propertyProperties The properties of the property.
* @return This object (for method chaining).
@@ -850,7 +850,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #addProperty(String,Map)}.
- *
+ *
* @param name The property name.
* @param propertyProperties The properties of the property.
* @return This object (for method chaining).
@@ -866,7 +866,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>additionalProperties</property>.
- *
+ *
* @return
* The value of the <property>additionalProperties</property> property on this bean, or <jk>null</jk> if it
* is not set.
@@ -877,7 +877,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>additionalProperties</property>.
- *
+ *
* @param additionalProperties The new value for the <property>additionalProperties</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -888,7 +888,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setAdditionalProperties(Map)}.
- *
+ *
* @param additionalProperties The new value for the <property>additionalProperties</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -903,7 +903,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>discriminator</property>.
- *
+ *
* @return
* The value of the <property>discriminator</property> property on this bean, or <jk>null</jk> if it is
* not set.
@@ -914,7 +914,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>discriminator</property>.
- *
+ *
* @param discriminator The new value for the <property>discriminator</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -925,7 +925,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setDiscriminator(String)}.
- *
+ *
* @param discriminator The new value for the <property>discriminator</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -935,7 +935,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>readOnly</property>.
- *
+ *
* @return The value of the <property>readOnly</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Boolean getReadOnly() {
@@ -944,7 +944,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>readOnly</property>.
- *
+ *
* @param readOnly The new value for the <property>readOnly</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -955,7 +955,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setReadOnly(Boolean)}.
- *
+ *
* @param readOnly The new value for the <property>readOnly</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -965,7 +965,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>xml</property>.
- *
+ *
* @return The value of the <property>xml</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Xml getXml() {
@@ -974,7 +974,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>xml</property>.
- *
+ *
* @param xml The new value for the <property>xml</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -985,7 +985,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setXml(Xml)}.
- *
+ *
* @param xml The new value for the <property>xml</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -995,7 +995,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>externalDocs</property>.
- *
+ *
* @return
* The value of the <property>externalDocs</property> property on this bean, or <jk>null</jk> if it is not
* set.
@@ -1006,7 +1006,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>externalDocs</property>.
- *
+ *
* @param externalDocs The new value for the <property>externalDocs</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -1017,7 +1017,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setExternalDocs(ExternalDocumentation)}.
- *
+ *
* @param externalDocs The new value for the <property>externalDocs</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -1027,7 +1027,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>example</property>.
- *
+ *
* @return The value of the <property>example</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Object getExample() {
@@ -1036,7 +1036,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>example</property>.
- *
+ *
* @param example The new value for the <property>example</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -1047,7 +1047,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setExample(Object)}.
- *
+ *
* @param example The new value for the <property>example</property> property on this bean.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java
index a7e2541..5ef3383 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java
@@ -21,25 +21,25 @@ import org.apache.juneau.annotation.*;
/**
* Allows the definition of a security scheme that can be used by the operations.
- *
+ *
* <p>
* Supported schemes are basic authentication, an API key (either as a header or as a query parameter) and OAuth2's
* common flows (implicit, password, application and access code).
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Basic authentication sample</jc>
* {
* <js>"type"</js>: <js>"basic"</js>
* }
- *
+ *
* <jc>// API key sample</jc>
* {
* <js>"type"</js>: <js>"apiKey"</js>,
* <js>"name"</js>: <js>"api_key"</js>,
* <js>"in"</js>: <js>"header"</js>
* }
- *
+ *
* <jc>// Implicit OAuth2 sample</jc>
* {
* <js>"type"</js>: <js>"oauth2"</js>,
@@ -51,7 +51,7 @@ import org.apache.juneau.annotation.*;
* }
* }
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -89,13 +89,13 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property getter: <property>type</property>.
- *
+ *
* <p>
* Required. The type of the security scheme.
- *
+ *
* <p>
* Valid values are <js>"basic"</js>, <js>"apiKey"</js> or <js>"oauth2"</js>.
- *
+ *
* @return The value of the <property>type</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getType() {
@@ -104,13 +104,13 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property setter: <property>type</property>.
- *
+ *
* <p>
* Required. The type of the security scheme.
- *
+ *
* <p>
* Valid values are <js>"basic"</js>, <js>"apiKey"</js> or <js>"oauth2"</js>.
- *
+ *
* @param type The new value for the <property>type</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -126,7 +126,7 @@ public class SecurityScheme extends SwaggerElement {
/**
* Synonym for {@link #setType(String)}.
- *
+ *
* @param type The new value for the <property>type</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -136,10 +136,10 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property getter: <property>description</property>.
- *
+ *
* <p>
* A short description for security scheme.
- *
+ *
* @return
* The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -149,10 +149,10 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property setter: <property>description</property>.
- *
+ *
* <p>
* A short description for security scheme.
- *
+ *
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -163,7 +163,7 @@ public class SecurityScheme extends SwaggerElement {
/**
* Synonym for {@link #setDescription(String)}.
- *
+ *
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -173,10 +173,10 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property getter: <property>name</property>.
- *
+ *
* <p>
* The name of the header or query parameter to be used.
- *
+ *
* @return The value of the <property>name</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getName() {
@@ -185,10 +185,10 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property setter: <property>name</property>.
- *
+ *
* <p>
* The name of the header or query parameter to be used.
- *
+ *
* @param name The new value for the <property>name</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -199,7 +199,7 @@ public class SecurityScheme extends SwaggerElement {
/**
* Synonym for {@link #setName(String)}.
- *
+ *
* @param name The new value for the <property>name</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -209,10 +209,10 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property getter: <property>in</property>.
- *
+ *
* <p>
* The location of the API key. Valid values are <js>"query"</js> or <js>"header"</js>.
- *
+ *
* @return The value of the <property>in</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getIn() {
@@ -221,10 +221,10 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property setter: <property>in</property>.
- *
+ *
* <p>
* The location of the API key. Valid values are <js>"query"</js> or <js>"header"</js>.
- *
+ *
* @param in The new value for the <property>in</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -235,7 +235,7 @@ public class SecurityScheme extends SwaggerElement {
/**
* Synonym for {@link #setIn(String)}.
- *
+ *
* @param in The new value for the <property>in</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -245,13 +245,13 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property getter: <property>flow</property>.
- *
+ *
* <p>
* The flow used by the OAuth2 security scheme.
- *
+ *
* <p>
* Valid values are <js>"implicit"</js>, <js>"password"</js>, <js>"application"</js> or <js>"accessCode"</js>.
- *
+ *
* @return The value of the <property>flow</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getFlow() {
@@ -260,13 +260,13 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property setter: <property>flow</property>.
- *
+ *
* <p>
* The flow used by the OAuth2 security scheme.
- *
+ *
* <p>
* Valid values are <js>"implicit"</js>, <js>"password"</js>, <js>"application"</js> or <js>"accessCode"</js>.
- *
+ *
* @param flow The new value for the <property>flow</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -277,7 +277,7 @@ public class SecurityScheme extends SwaggerElement {
/**
* Synonym for {@link #setFlow(String)}.
- *
+ *
* @param flow The new value for the <property>flow</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -287,13 +287,13 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property getter: <property>authorizationUrl</property>.
- *
+ *
* <p>
* The authorization URL to be used for this flow.
- *
+ *
* <p>
* This SHOULD be in the form of a URL.
- *
+ *
* @return
* The value of the <property>authorizationUrl</property> property on this bean, or <jk>null</jk> if it
* is not set.
@@ -304,13 +304,13 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property setter: <property>authorizationUrl</property>.
- *
+ *
* <p>
* The authorization URL to be used for this flow.
- *
+ *
* <p>
* This SHOULD be in the form of a URL.
- *
+ *
* @param authorizationUrl The new value for the <property>authorizationUrl</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -321,7 +321,7 @@ public class SecurityScheme extends SwaggerElement {
/**
* Synonym for {@link #setAuthorizationUrl(String)}.
- *
+ *
* @param authorizationUrl The new value for the <property>authorizationUrl</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -331,13 +331,13 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property getter: <property>tokenUrl</property>.
- *
+ *
* <p>
* The token URL to be used for this flow.
- *
+ *
* <p>
* This SHOULD be in the form of a URL.
- *
+ *
* @return The value of the <property>tokenUrl</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getTokenUrl() {
@@ -346,13 +346,13 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property setter: <property>tokenUrl</property>.
- *
+ *
* <p>
* The token URL to be used for this flow.
- *
+ *
* <p>
* This SHOULD be in the form of a URL.
- *
+ *
* @param tokenUrl The new value for the <property>tokenUrl</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -363,7 +363,7 @@ public class SecurityScheme extends SwaggerElement {
/**
* Synonym for {@link #setTokenUrl(String)}.
- *
+ *
* @param tokenUrl The new value for the <property>tokenUrl</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -373,10 +373,10 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property getter: <property>scopes</property>.
- *
+ *
* <p>
* The available scopes for the OAuth2 security scheme.
- *
+ *
* @return The value of the <property>scopes</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Map<String,String> getScopes() {
@@ -385,10 +385,10 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property setter: <property>scopes</property>.
- *
+ *
* <p>
* The available scopes for the OAuth2 security scheme.
- *
+ *
* @param scopes The new value for the <property>scopes</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -399,10 +399,10 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property adder: <property>scopes</property>.
- *
+ *
* <p>
* The available scopes for the OAuth2 security scheme.
- *
+ *
* @param name The name of the scope.
* @param description A short description of the scope.
* @return This object (for method chaining).
@@ -416,7 +416,7 @@ public class SecurityScheme extends SwaggerElement {
/**
* Synonym for {@link #addScope(String,String)}.
- *
+ *
* @param name The name of the scope.
* @param description A short description of the scope.
* @return This object (for method chaining).