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:54 UTC
[26/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/HeaderInfo.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java
index ef01f78..ee1c6bb 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java
@@ -21,7 +21,7 @@ import org.apache.juneau.annotation.*;
/**
* Describes a single HTTP header.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* {
@@ -29,7 +29,7 @@ import org.apache.juneau.annotation.*;
* <js>"type"</js>: <js>"integer"</js>
* }
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -79,10 +79,10 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>description</property>.
- *
+ *
* <p>
* A short description of the header.
- *
+ *
* @return
* The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -92,10 +92,10 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>description</property>.
- *
+ *
* <p>
* A short description of the header.
- *
+ *
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -106,7 +106,7 @@ public class HeaderInfo extends SwaggerElement {
/**
* Synonym for {@link #description(String)}.
- *
+ *
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -116,12 +116,12 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>type</property>.
- *
+ *
* <p>
* Required. The type of the object.
* The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>, or <
* js>"array"</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() {
@@ -130,12 +130,12 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>type</property>.
- *
+ *
* <p>
* Required. The type of the object.
* The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>, or
* <js>"array"</js>.
- *
+ *
* @param type The new value for the <property>type</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -151,7 +151,7 @@ public class HeaderInfo 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).
*/
@@ -161,12 +161,12 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>format</property>.
- *
+ *
* <p>
* The extending format for the previously mentioned <code>type</code>.
* 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() {
@@ -175,12 +175,12 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>format</property>.
- *
+ *
* <p>
* The extending format for the previously mentioned <code>type</code>.
* 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).
*/
@@ -191,7 +191,7 @@ public class HeaderInfo 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).
*/
@@ -201,11 +201,11 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>items</property>.
- *
+ *
* <p>
* Required if <code>type</code> is <js>"array"</js>.
* 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() {
@@ -214,11 +214,11 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>items</property>.
- *
+ *
* <p>
* Required if <code>type</code> is <js>"array"</js>.
* 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).
*/
@@ -229,7 +229,7 @@ public class HeaderInfo 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).
*/
@@ -239,11 +239,11 @@ public class HeaderInfo 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>
* <li><code>csv</code> - comma separated values <code>foo,bar</code>.
@@ -251,10 +251,10 @@ public class HeaderInfo extends SwaggerElement {
* <li><code>tsv</code> - tab separated values <code>foo\tbar</code>.
* <li><code>pipes</code> - pipe separated values <code>foo|bar</code>.
* </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.
*/
@@ -264,10 +264,10 @@ public class HeaderInfo 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>
@@ -276,10 +276,10 @@ public class HeaderInfo extends SwaggerElement {
* <li><code>tsv</code> - tab separated values <code>foo\tbar</code>.
* <li><code>pipes</code> - pipe separated values <code>foo|bar</code>.
* </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).
*/
@@ -295,7 +295,7 @@ public class HeaderInfo 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).
*/
@@ -305,14 +305,14 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>default</property>.
- *
+ *
* <p>
* Declares the value of the header that the server will use if none is provided.
* (Note: <js>"default"</js> has no meaning for required items.)
* 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 the header.
- *
+ *
* @return The value of the <property>_default</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Object getDefault() {
@@ -321,14 +321,14 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>default</property>.
- *
+ *
* <p>
* Declares the value of the header that the server will use if none is provided.
* (Note: <js>"default"</js> has no meaning for required items.)
* 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 the header.
- *
+ *
* @param _default The new value for the <property>_default</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -339,7 +339,7 @@ public class HeaderInfo 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).
*/
@@ -349,11 +349,11 @@ public class HeaderInfo 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() {
@@ -362,11 +362,11 @@ public class HeaderInfo 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).
*/
@@ -377,7 +377,7 @@ public class HeaderInfo 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).
*/
@@ -387,11 +387,11 @@ public class HeaderInfo 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.
*/
@@ -401,11 +401,11 @@ public class HeaderInfo 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).
*/
@@ -416,7 +416,7 @@ public class HeaderInfo 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).
*/
@@ -426,11 +426,11 @@ public class HeaderInfo 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() {
@@ -439,11 +439,11 @@ public class HeaderInfo 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).
*/
@@ -454,7 +454,7 @@ public class HeaderInfo 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).
*/
@@ -464,11 +464,11 @@ public class HeaderInfo 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.
*/
@@ -478,11 +478,11 @@ public class HeaderInfo 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).
*/
@@ -493,7 +493,7 @@ public class HeaderInfo 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).
*/
@@ -503,11 +503,11 @@ public class HeaderInfo 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() {
@@ -516,11 +516,11 @@ public class HeaderInfo 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).
*/
@@ -531,7 +531,7 @@ public class HeaderInfo 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).
*/
@@ -541,11 +541,11 @@ public class HeaderInfo 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() {
@@ -554,11 +554,11 @@ public class HeaderInfo 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).
*/
@@ -577,11 +577,11 @@ public class HeaderInfo 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() {
@@ -590,11 +590,11 @@ public class HeaderInfo 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).
*/
@@ -605,7 +605,7 @@ public class HeaderInfo 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).
*/
@@ -615,11 +615,11 @@ public class HeaderInfo 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() {
@@ -628,11 +628,11 @@ public class HeaderInfo 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).
*/
@@ -643,7 +643,7 @@ public class HeaderInfo 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).
*/
@@ -653,11 +653,11 @@ public class HeaderInfo 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() {
@@ -666,11 +666,11 @@ public class HeaderInfo 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).
*/
@@ -681,7 +681,7 @@ public class HeaderInfo 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).
*/
@@ -691,11 +691,11 @@ public class HeaderInfo 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.
*/
public Boolean getUniqueItems() {
@@ -704,11 +704,11 @@ public class HeaderInfo 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).
*/
@@ -719,7 +719,7 @@ public class HeaderInfo 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).
*/
@@ -729,11 +729,11 @@ public class HeaderInfo 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() {
@@ -742,11 +742,11 @@ public class HeaderInfo 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).
*/
@@ -757,11 +757,11 @@ public class HeaderInfo 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.
@@ -784,7 +784,7 @@ public class HeaderInfo extends SwaggerElement {
/**
* Synonym for {@link #addEnum(Object...)}.
- *
+ *
* @param _enum The new value for the <property>enum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -794,11 +794,11 @@ public class HeaderInfo 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() {
@@ -807,11 +807,11 @@ public class HeaderInfo 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).
*/
@@ -822,7 +822,7 @@ public class HeaderInfo 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/Info.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Info.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Info.java
index 6a03d0a..35cfe6c 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Info.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Info.java
@@ -17,7 +17,7 @@ import org.apache.juneau.annotation.*;
/**
* The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented
* in the Swagger-UI for convenience.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* {
@@ -36,7 +36,7 @@ import org.apache.juneau.annotation.*;
* <js>"version"</js>: <js>"1.0.1"</js>
* }
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -64,10 +64,10 @@ public class Info extends SwaggerElement {
/**
* Bean property getter: <property>title</property>.
- *
+ *
* <p>
* Required. The title of the application.
- *
+ *
* @return The value of the <property>title</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getTitle() {
@@ -76,10 +76,10 @@ public class Info extends SwaggerElement {
/**
* Bean property setter: <property>title</property>.
- *
+ *
* <p>
* Required. The title of the application.
- *
+ *
* @param title The new value for the <property>title</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -90,7 +90,7 @@ public class Info 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).
*/
@@ -100,10 +100,10 @@ public class Info extends SwaggerElement {
/**
* Bean property getter: <property>description</property>.
- *
+ *
* <p>
* A short description of the application. GFM syntax 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.
*/
@@ -113,10 +113,10 @@ public class Info extends SwaggerElement {
/**
* Bean property setter: <property>description</property>.
- *
+ *
* <p>
* A short description of the application. GFM syntax 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).
*/
@@ -127,7 +127,7 @@ public class Info 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).
*/
@@ -137,10 +137,10 @@ public class Info extends SwaggerElement {
/**
* Bean property getter: <property>termsOfService</property>.
- *
+ *
* <p>
* The Terms of Service for the API.
- *
+ *
* @return The value of the <property>termsOfService</property> property on this bean, or <jk>null</jk> if it is not
* set.
*/
@@ -150,10 +150,10 @@ public class Info extends SwaggerElement {
/**
* Bean property setter: <property>termsOfService</property>.
- *
+ *
* <p>
* The Terms of Service for the API.
- *
+ *
* @param termsOfService The new value for the <property>termsOfService</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -164,7 +164,7 @@ public class Info extends SwaggerElement {
/**
* Synonym for {@link #setTermsOfService(String)}.
- *
+ *
* @param termsOfService The new value for the <property>termsOfService</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -174,10 +174,10 @@ public class Info extends SwaggerElement {
/**
* Bean property getter: <property>contact</property>.
- *
+ *
* <p>
* The contact information for the exposed API.
- *
+ *
* @return The value of the <property>contact</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Contact getContact() {
@@ -186,10 +186,10 @@ public class Info extends SwaggerElement {
/**
* Bean property setter: <property>contact</property>.
- *
+ *
* <p>
* The contact information for the exposed API.
- *
+ *
* @param contact The new value for the <property>contact</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -200,7 +200,7 @@ public class Info extends SwaggerElement {
/**
* Synonym for {@link #setContact(Contact)}.
- *
+ *
* @param contact The new value for the <property>contact</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -210,10 +210,10 @@ public class Info extends SwaggerElement {
/**
* Bean property getter: <property>license</property>.
- *
+ *
* <p>
* The license information for the exposed API.
- *
+ *
* @return The value of the <property>license</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public License getLicense() {
@@ -222,10 +222,10 @@ public class Info extends SwaggerElement {
/**
* Bean property setter: <property>license</property>.
- *
+ *
* <p>
* The license information for the exposed API.
- *
+ *
* @param license The new value for the <property>license</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -236,7 +236,7 @@ public class Info extends SwaggerElement {
/**
* Synonym for {@link #setLicense(License)}.
- *
+ *
* @param license The new value for the <property>license</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -246,10 +246,10 @@ public class Info extends SwaggerElement {
/**
* Bean property getter: <property>version</property>.
- *
+ *
* <p>
* Required. Provides the version of the application API (not to be confused with the specification version).
- *
+ *
* @return The value of the <property>version</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getVersion() {
@@ -258,10 +258,10 @@ public class Info extends SwaggerElement {
/**
* Bean property setter: <property>version</property>.
- *
+ *
* <p>
* Required. Provides the version of the application API (not to be confused with the specification version).
- *
+ *
* @param version The new value for the <property>version</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -272,7 +272,7 @@ public class Info extends SwaggerElement {
/**
* Synonym for {@link #setVersion(String)}.
- *
+ *
* @param version The new value for the <property>version</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/Items.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Items.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Items.java
index 6aafda4..c5a4793 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Items.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Items.java
@@ -22,7 +22,7 @@ import org.apache.juneau.json.*;
/**
* A limited subset of JSON-Schema's items object. It is used by parameter definitions that are not located in "body".
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* {
@@ -30,7 +30,7 @@ import org.apache.juneau.json.*;
* <js>"minLength"</js>: 2
* }
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -79,12 +79,12 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>type</property>.
- *
+ *
* <p>
* Required. The internal type of the array.
* The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>, or
* <js>"array"</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() {
@@ -93,12 +93,12 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>type</property>.
- *
+ *
* <p>
* Required. The internal type of the array.
* The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>, or
* <js>"array"</js>.
- *
+ *
* @param type The new value for the <property>type</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -113,7 +113,7 @@ public class Items 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).
*/
@@ -123,11 +123,11 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>format</property>.
- *
+ *
* <p>
* The extending format for the previously mentioned <code>type</code>. 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() {
@@ -136,11 +136,11 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>format</property>.
- *
+ *
* <p>
* The extending format for the previously mentioned <code>type</code>. 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).
*/
@@ -151,7 +151,7 @@ public class Items 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).
*/
@@ -161,11 +161,11 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>items</property>.
- *
+ *
* <p>
* Required if <code>type</code> is <js>"array"</js>.
* 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() {
@@ -174,11 +174,11 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>items</property>.
- *
+ *
* <p>
* Required if <code>type</code> is <js>"array"</js>.
* 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).
*/
@@ -189,7 +189,7 @@ public class Items 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).
*/
@@ -199,10 +199,10 @@ public class Items 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>
@@ -211,10 +211,10 @@ public class Items extends SwaggerElement {
* <li><code>tsv</code> - tab separated values <code>foo\tbar</code>.
* <li><code>pipes</code> - pipe separated values <code>foo|bar</code>.
* </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.
@@ -225,10 +225,10 @@ public class Items 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>
@@ -237,10 +237,10 @@ public class Items extends SwaggerElement {
* <li><code>tsv</code> - tab separated values <code>foo\tbar</code>.
* <li><code>pipes</code> - pipe separated values <code>foo|bar</code>.
* </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).
*/
@@ -256,7 +256,7 @@ public class Items 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).
*/
@@ -266,14 +266,14 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>default</property>.
- *
+ *
* <p>
* Declares the value of the item that the server will use if none is provided.
* (Note: <js>"default"</js> has no meaning for required items.)
* 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 the data type.
- *
+ *
* @return The value of the <property>default</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Object getDefault() {
@@ -282,14 +282,14 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>default</property>.
- *
+ *
* <p>
* Declares the value of the item that the server will use if none is provided.
* (Note: <js>"default"</js> has no meaning for required items.)
* 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 the data type.
- *
+ *
* @param _default The new value for the <property>default</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -300,7 +300,7 @@ public class Items 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).
*/
@@ -310,11 +310,11 @@ public class Items 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() {
@@ -323,11 +323,11 @@ public class Items 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).
*/
@@ -338,7 +338,7 @@ public class Items 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).
*/
@@ -348,11 +348,11 @@ public class Items 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.
@@ -363,11 +363,11 @@ public class Items 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).
*/
@@ -378,7 +378,7 @@ public class Items 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).
*/
@@ -388,11 +388,11 @@ public class Items 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() {
@@ -401,11 +401,11 @@ public class Items 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).
*/
@@ -416,7 +416,7 @@ public class Items 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).
*/
@@ -426,11 +426,11 @@ public class Items 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.
*/
@@ -440,11 +440,11 @@ public class Items 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).
*/
@@ -455,7 +455,7 @@ public class Items 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).
*/
@@ -465,11 +465,11 @@ public class Items 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() {
@@ -478,11 +478,11 @@ public class Items 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).
*/
@@ -493,7 +493,7 @@ public class Items 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).
*/
@@ -503,11 +503,11 @@ public class Items 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() {
@@ -516,11 +516,11 @@ public class Items 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).
*/
@@ -531,7 +531,7 @@ public class Items 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).
*/
@@ -541,11 +541,11 @@ public class Items 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() {
@@ -554,11 +554,11 @@ public class Items 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).
*/
@@ -569,7 +569,7 @@ public class Items 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).
*/
@@ -579,11 +579,11 @@ public class Items 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() {
@@ -592,11 +592,11 @@ public class Items 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).
*/
@@ -607,7 +607,7 @@ public class Items 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).
*/
@@ -617,11 +617,11 @@ public class Items 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() {
@@ -630,11 +630,11 @@ public class Items 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).
*/
@@ -645,7 +645,7 @@ public class Items 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).
*/
@@ -655,11 +655,11 @@ public class Items 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.
*/
@@ -669,11 +669,11 @@ public class Items 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).
*/
@@ -684,7 +684,7 @@ public class Items 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).
*/
@@ -694,11 +694,11 @@ public class Items 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() {
@@ -707,11 +707,11 @@ public class Items 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).
*/
@@ -722,11 +722,11 @@ public class Items 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.
@@ -749,7 +749,7 @@ public class Items 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.
@@ -761,11 +761,11 @@ public class Items 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() {
@@ -774,11 +774,11 @@ public class Items 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).
*/
@@ -789,7 +789,7 @@ public class Items 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/License.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/License.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/License.java
index 5b2a022..51aae5d 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/License.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/License.java
@@ -22,7 +22,7 @@ import org.apache.juneau.annotation.*;
/**
* License information for the exposed API.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* {
@@ -30,7 +30,7 @@ import org.apache.juneau.annotation.*;
* <js>"url"</js>: <js>"http://www.apache.org/licenses/LICENSE-2.0.html"</js>
* }
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -54,10 +54,10 @@ public class License extends SwaggerElement {
/**
* Bean property getter: <property>name</property>.
- *
+ *
* <p>
* Required. The license name used for the API.
- *
+ *
* @return The value of the <property>name</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getName() {
@@ -66,10 +66,10 @@ public class License extends SwaggerElement {
/**
* Bean property setter: <property>name</property>.
- *
+ *
* <p>
* Required. The license name used for the API.
- *
+ *
* @param name The new value for the <property>name</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -80,7 +80,7 @@ public class License 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).
*/
@@ -90,17 +90,17 @@ public class License extends SwaggerElement {
/**
* Bean property getter: <property>url</property>.
- *
+ *
* <p>
* A URL to the license used for the API.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @return The value of the <property>url</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public URI getUrl() {
@@ -109,14 +109,14 @@ public class License extends SwaggerElement {
/**
* Bean property setter: <property>url</property>.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param url The new value for the <property>url</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -127,7 +127,7 @@ public class License extends SwaggerElement {
/**
* Synonym for {@link #setUrl(Object)}.
- *
+ *
* @param url The new value for the <property>url</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/Operation.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Operation.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Operation.java
index ec00295..be867bb 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Operation.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Operation.java
@@ -19,7 +19,7 @@ import org.apache.juneau.http.*;
/**
* Describes a single API operation on a path.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* {
@@ -77,7 +77,7 @@ import org.apache.juneau.http.*;
* ]
* }
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -111,11 +111,11 @@ public class Operation extends SwaggerElement {
/**
* Bean property getter: <property>tags</property>.
- *
+ *
* <p>
* A list of tags for API documentation control.
* Tags can be used for logical grouping of operations by resources or any other qualifier.
- *
+ *
* @return The value of the <property>tags</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public List<String> getTags() {
@@ -124,11 +124,11 @@ public class Operation extends SwaggerElement {
/**
* Bean property setter: <property>tags</property>.
- *
+ *
* <p>
* A list of tags for API documentation control.
* Tags can be used for logical grouping of operations by resources or any other qualifier.
- *
+ *
* @param tags The new value for the <property>tags</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -139,11 +139,11 @@ public class Operation extends SwaggerElement {
/**
* Bean property adder: <property>tags</property>.
- *
+ *
* <p>
* A list of tags for API documentation control.
* Tags can be used for logical grouping of operations by resources or any other qualifier.
- *
+ *
* @param tags The values to add for the <property>tags</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -153,11 +153,11 @@ public class Operation extends SwaggerElement {
/**
* Bean property adder: <property>tags</property>.
- *
+ *
* <p>
* A list of tags for API documentation control.
* Tags can be used for logical grouping of operations by resources or any other qualifier.
- *
+ *
* @param tags
* The values to add for the <property>tags</property> property on this bean.
* Ignored if <jk>null</jk>.
@@ -174,7 +174,7 @@ public class Operation extends SwaggerElement {
/**
* Synonym for {@link #addTags(String...)}.
- *
+ *
* @param tags The new value for the <property>tags</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -184,7 +184,7 @@ public class Operation extends SwaggerElement {
/**
* Synonym for {@link #addTags(Collection)}.
- *
+ *
* @param tags The new value for the <property>tags</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -194,11 +194,11 @@ public class Operation extends SwaggerElement {
/**
* Bean property getter: <property>summary</property>.
- *
+ *
* <p>
* A short summary of what the operation does.
* For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
- *
+ *
* @return The value of the <property>summary</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getSummary() {
@@ -207,11 +207,11 @@ public class Operation extends SwaggerElement {
/**
* Bean property setter: <property>summary</property>.
- *
+ *
* <p>
* A short summary of what the operation does.
* For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
- *
+ *
* @param summary The new value for the <property>summary</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -222,7 +222,7 @@ public class Operation extends SwaggerElement {
/**
* Synonym for {@link #setSummary(String)}.
- *
+ *
* @param summary The new value for the <property>summary</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -232,12 +232,12 @@ public class Operation extends SwaggerElement {
/**
* Bean property getter: <property>description</property>.
- *
+ *
* <p>
* A verbose explanation of the operation behavior.
* <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.
*/
@@ -247,12 +247,12 @@ public class Operation extends SwaggerElement {
/**
* Bean property setter: <property>description</property>.
- *
+ *
* <p>
* A verbose explanation of the operation behavior.
* <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).
*/
@@ -263,7 +263,7 @@ public class Operation 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).
*/
@@ -273,10 +273,10 @@ public class Operation extends SwaggerElement {
/**
* Bean property getter: <property>externalDocs</property>.
- *
+ *
* <p>
* Additional external documentation for this operation.
- *
+ *
* @return
* The value of the <property>externalDocs</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -286,10 +286,10 @@ public class Operation extends SwaggerElement {
/**
* Bean property setter: <property>externalDocs</property>.
- *
+ *
* <p>
* Additional external documentation for this operation.
- *
+ *
* @param externalDocs The new value for the <property>externalDocs</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -300,7 +300,7 @@ public class Operation 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).
*/
@@ -310,12 +310,12 @@ public class Operation extends SwaggerElement {
/**
* Bean property getter: <property>operationId</property>.
- *
+ *
* <p>
* Unique string used to identify the operation. The id MUST be unique among all operations described in the API.
* Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to
* follow common programming naming conventions.
- *
+ *
* @return
* The value of the <property>operationId</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -325,12 +325,12 @@ public class Operation extends SwaggerElement {
/**
* Bean property setter: <property>operationId</property>.
- *
+ *
* <p>
* Unique string used to identify the operation. The id MUST be unique among all operations described in the API.
* Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to
* follow common programming naming conventions.
- *
+ *
* @param operationId The new value for the <property>operationId</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -341,7 +341,7 @@ public class Operation extends SwaggerElement {
/**
* Synonym for {@link #setOperationId(String)}.
- *
+ *
* @param operationId The new value for the <property>operationId</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -351,13 +351,13 @@ public class Operation extends SwaggerElement {
/**
* Bean property getter: <property>consumes</property>.
- *
+ *
* <p>
* A list of MIME types the operation can consume.
* This overrides the <code>consumes</code> definition at the Swagger Object.
* An empty value MAY be used to clear the global definition.
* Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
- *
+ *
* @return The value of the <property>consumes</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public List<MediaType> getConsumes() {
@@ -366,13 +366,13 @@ public class Operation extends SwaggerElement {
/**
* Bean property setter: <property>consumes</property>.
- *
+ *
* <p>
* A list of MIME types the operation can consume.
* This overrides the <code>consumes</code> definition at the Swagger Object.
* An empty value MAY be used to clear the global definition.
* Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
- *
+ *
* @param consumes The new value for the <property>consumes</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -383,13 +383,13 @@ public class Operation extends SwaggerElement {
/**
* Bean property adder: <property>consumes</property>.
- *
+ *
* <p>
* A list of MIME types the operation can consume.
* This overrides the <code>consumes</code> definition at the Swagger Object.
* An empty value MAY be used to clear the global definition.
* Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
- *
+ *
* @param consumes The new values to add to the <property>consumes</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -399,13 +399,13 @@ public class Operation extends SwaggerElement {
/**
* Bean property adder: <property>consumes</property>.
- *
+ *
* <p>
* A list of MIME types the operation can consume.
* This overrides the <code>consumes</code> definition at the Swagger Object.
* An empty value MAY be used to clear the global definition.
* Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
- *
+ *
* @param consumes The new values to add to the <property>consumes</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -420,7 +420,7 @@ public class Operation extends SwaggerElement {
/**
* Synonym for {@link #addConsumes(MediaType...)}.
- *
+ *
* @param consumes The new values to add to the <property>consumes</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -430,7 +430,7 @@ public class Operation extends SwaggerElement {
/**
* Synonym for {@link #addConsumes(Collection)}.
- *
+ *
* @param consumes The new values to add to the <property>consumes</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -440,13 +440,13 @@ public class Operation extends SwaggerElement {
/**
* Bean property getter: <property>produces</property>.
- *
+ *
* <p>
* A list of MIME types the operation can produce.
* This overrides the <code>produces</code> definition at the Swagger Object.
* An empty value MAY be used to clear the global definition.
* Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
- *
+ *
* @return The value of the <property>produces</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public List<MediaType> getProduces() {
@@ -455,13 +455,13 @@ public class Operation extends SwaggerElement {
/**
* Bean property setter: <property>produces</property>.
- *
+ *
* <p>
* A list of MIME types the operation can produce.
* This overrides the <code>produces</code> definition at the Swagger Object.
* An empty value MAY be used to clear the global definition.
* Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
- *
+ *
* @param produces The new value for the <property>produces</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -472,13 +472,13 @@ public class Operation extends SwaggerElement {
/**
* Bean property adder: <property>produces</property>.
- *
+ *
* <p>
* A list of MIME types the operation can produce.
* This overrides the <code>produces</code> definition at the Swagger Object.
* An empty value MAY be used to clear the global definition.
* Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
- *
+ *
* @param produces The new value for the <property>produces</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -493,13 +493,13 @@ public class Operation extends SwaggerElement {
/**
* Bean property adder: <property>produces</property>.
- *
+ *
* <p>
* A list of MIME types the operation can produces.
* This overrides the <code>produces</code> definition at the Swagger Object.
* An empty value MAY be used to clear the global definition.
* Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
- *
+ *
* @param produces The new values to add to the <property>produces</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -514,7 +514,7 @@ public class Operation extends SwaggerElement {
/**
* Synonym for {@link #addProduces(MediaType...)}.
- *
+ *
* @param produces The new value for the <property>produces</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -524,7 +524,7 @@ public class Operation extends SwaggerElement {
/**
* Synonym for {@link #addProduces(Collection)}.
- *
+ *
* @param produces The new value for the <property>produces</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -534,7 +534,7 @@ public class Operation extends SwaggerElement {
/**
* Bean property getter: <property>parameters</property>.
- *
+ *
* <p>
* A list of parameters that are applicable for this operation.
* If a parameter is already defined at the <a class="doclink"
@@ -545,7 +545,7 @@ public class Operation extends SwaggerElement {
* The list can use the <a class="doclink" href="http://swagger.io/specification/#referenceObject">Reference Object</a>
* to link to parameters that are defined at the <a class="doclink" href="http://swagger.io/specification/#swaggerParameters">Swagger Object's parameters</a>.
* There can be one <js>"body"</js> parameter at most.
- *
+ *
* @return The value of the <property>parameters</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public List<ParameterInfo> getParameters() {
@@ -554,7 +554,7 @@ public class Operation extends SwaggerElement {
/**
* Bean property setter: <property>parameters</property>.
- *
+ *
* <p>
* A list of parameters that are applicable for this operation.
* If a parameter is already defined at the <a class="doclink"
@@ -567,7 +567,7 @@ public class Operation extends SwaggerElement {
* defined at the <a class="doclink"
* href="http://swagger.io/specification/#swaggerParameters">Swagger Object's parameters</a>.
* There can be one <js>"body"</js> parameter at most.
- *
+ *
* @param parameters The new value for the <property>parameters</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -578,7 +578,7 @@ public class Operation extends SwaggerElement {
/**
* Bean property adder: <property>parameters</property>.
- *
+ *
* <p>
* A list of parameters that are applicable for this operation.
* If a parameter is already defined at the <a class="doclink"
@@ -591,7 +591,7 @@ public class Operation extends SwaggerElement {
* defined at the <a class="doclink"
* href="http://swagger.io/specification/#swaggerParameters">Swagger Object's parameters</a>.
* There can be one <js>"body"</js> parameter at most.
- *
+ *
* @param parameters The new value to add to the <property>parameters</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -604,7 +604,7 @@ public class Operation extends SwaggerElement {
/**
* Synonym for {@link #addParameters(ParameterInfo...)}.
- *
+ *
* @param parameters The new value to add to the <property>parameters</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -614,7 +614,7 @@ public class Operation extends SwaggerElement {
/**
* Synonym for {@link #setParameters(List)}.
- *
+ *
* @param parameters The new value to add to the <property>parameters</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -624,10 +624,10 @@ public class Operation extends SwaggerElement {
/**
* Bean property getter: <property>responses</property>.
- *
+ *
* <p>
* Required. The list of possible responses as they are returned from executing this operation.
- *
+ *
* @return The value of the <property>responses</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Map<Integer,ResponseInfo> getResponses() {
@@ -636,10 +636,10 @@ public class Operation extends SwaggerElement {
/**
* Bean property setter: <property>responses</property>.
- *
+ *
* <p>
* Required. The list of possible responses as they are returned from executing this operation.
- *
+ *
* @param responses The new value for the <property>responses</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -650,10 +650,10 @@ public class Operation extends SwaggerElement {
/**
* Bean property adder: <property>responses</property>.
- *
+ *
* <p>
* Required. The list of possible responses as they are returned from executing this operation.
- *
+ *
* @param statusCode The HTTP status code.
* @param response The response description.
* @return This object (for method chaining).
@@ -667,7 +667,7 @@ public class Operation extends SwaggerElement {
/**
* Synonym for {@link #addResponse(Integer,ResponseInfo)}.
- *
+ *
* @param statusCode The HTTP status code.
* @param response The response description.
* @return This object (for method chaining).
@@ -678,7 +678,7 @@ public class Operation extends SwaggerElement {
/**
* Synonym for {@link #setResponses(Map)}.
- *
+ *
* @param responses The new value for the <property>responses</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -688,12 +688,12 @@ public class Operation extends SwaggerElement {
/**
* Bean property getter: <property>schemes</property>.
- *
+ *
* <p>
* The transfer protocol for the operation.
* Values MUST be from the list: <js>"http"</js>, <js>"https"</js>, <js>"ws"</js>, <js>"wss"</js>.
* The value overrides the Swagger Object <code>schemes</code> definition.
- *
+ *
* @return The value of the <property>schemes</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public List<String> getSchemes() {
@@ -702,12 +702,12 @@ public class Operation extends SwaggerElement {
/**
* Bean property setter: <property>schemes</property>.
- *
+ *
* <p>
* The transfer protocol for the operation.
* Values MUST be from the list: <js>"http"</js>, <js>"https"</js>, <js>"ws"</js>, <js>"wss"</js>.
* The value overrides the Swagger Object <code>schemes</code> definition.
- *
+ *
* @param schemes The new value for the <property>schemes</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -718,12 +718,12 @@ public class Operation extends SwaggerElement {
/**
* Bean property adder: <property>schemes</property>.
- *
+ *
* <p>
* The transfer protocol for the operation.
* Values MUST be from the list: <js>"http"</js>, <js>"https"</js>, <js>"ws"</js>, <js>"wss"</js>.
* The value overrides the Swagger Object <code>schemes</code> definition.
- *
+ *
* @param schemes The new values to add to the <property>schemes</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -733,12 +733,12 @@ public class Operation extends SwaggerElement {
/**
* Bean property adder: <property>schemes</property>.
- *
+ *
* <p>
* The transfer protocol for the operation.
* Values MUST be from the list: <js>"http"</js>, <js>"https"</js>, <js>"ws"</js>, <js>"wss"</js>.
* The value overrides the Swagger Object <code>schemes</code> definition.
- *
+ *
* @param schemes The new values to add to the <property>schemes</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -751,7 +751,7 @@ public class Operation extends SwaggerElement {
/**
* Synonym for {@link #addSchemes(String...)}.
- *
+ *
* @param schemes The new values to add to the <property>schemes</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -761,12 +761,12 @@ public class Operation extends SwaggerElement {
/**
* Bean property getter: <property>deprecated</property>.
- *
+ *
* <p>
* Declares this operation to be deprecated.
* Usage of the declared operation should be refrained.
* Default value is <jk>false</jk>.
- *
+ *
* @return The value of the <property>deprecated</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Boolean getDeprecated() {
@@ -775,12 +775,12 @@ public class Operation extends SwaggerElement {
/**
* Bean property setter: <property>deprecated</property>.
- *
+ *
* <p>
* Declares this operation to be deprecated.
* Usage of the declared operation should be refrained.
* Default value is <jk>false</jk>.
- *
+ *
* @param deprecated The new value for the <property>deprecated</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -791,7 +791,7 @@ public class Operation extends SwaggerElement {
/**
* Synonym for {@link #setDeprecated(Boolean)}.
- *
+ *
* @param deprecated The new value for the <property>deprecated</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -801,14 +801,14 @@ public class Operation extends SwaggerElement {
/**
* Bean property getter: <property>security</property>.
- *
+ *
* <p>
* A declaration of which security schemes are applied for this operation.
* The list of values describes alternative security schemes that can be used (that is, there is a logical OR
* between the security requirements).
* This definition overrides any declared top-level security.
* To remove a top-level <code>security</code> declaration, an empty array can be used.
- *
+ *
* @return The value of the <property>security</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public List<Map<String,List<String>>> getSecurity() {
@@ -817,14 +817,14 @@ public class Operation extends SwaggerElement {
/**
* Bean property setter: <property>security</property>.
- *
+ *
* <p>
* A declaration of which security schemes are applied for this operation.
* The list of values describes alternative security schemes that can be used (that is, there is a logical OR
* between the security requirements).
* This definition overrides any declared top-level security.
* To remove a top-level <code>security</code> declaration, an empty array can be used.
- *
+ *
* @param security The new value for the <property>security</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -835,14 +835,14 @@ public class Operation extends SwaggerElement {
/**
* Bean property adder: <property>security</property>.
- *
+ *
* <p>
* A declaration of which security schemes are applied for this operation.
* The list of values describes alternative security schemes that can be used (that is, there is a logical OR
* between the security requirements).
* This definition overrides any declared top-level security.
* To remove a top-level <code>security</code> declaration, an empty array can be used.
- *
+ *
* @param security The new value to add to the <property>security</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -855,7 +855,7 @@ public class Operation extends SwaggerElement {
/**
* Synonym for {@link #addSecurity(Map)}.
- *
+ *
* @param scheme The security scheme that applies to this operation
* @param alternatives
* The list of values describes alternative security schemes that can be used (that is, there is a logical OR