http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/Schema.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/Schema.java b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/Schema.java index 811ca40..2e65494 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/Schema.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/Schema.java @@ -134,9 +134,11 @@ public class Schema { /** * Bean property setter: <property>id</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. * @@ -160,9 +162,11 @@ public class Schema { /** * Bean property setter: <property>$schema</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. * @@ -218,8 +222,9 @@ public class Schema { /** * 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. - * Can be either a {@link JsonType} or {@link JsonTypeArray} depending on what value was used to set it. + * @return + * The value of the <property>type</property> property on this bean, or <jk>null</jk> if it is not set. + * Can be either a {@link JsonType} or {@link JsonTypeArray} depending on what value was used to set it. */ @BeanProperty(swap=JsonTypeOrJsonTypeArraySwap.class) public Object getType() { @@ -230,11 +235,12 @@ public class Schema { /** * Bean property getter: <property>type</property>. + * * <p> * Convenience method for returning the <property>type</property> property when it is a {@link JsonType} value. * - * @return The currently set value, or <jk>null</jk> if the property is not set, or is set as a - * {@link JsonTypeArray}. + * @return + * The currently set value, or <jk>null</jk> if the property is not set, or is set as a {@link JsonTypeArray}. */ @BeanIgnore public JsonType getTypeAsJsonType() { @@ -243,6 +249,7 @@ public class Schema { /** * Bean property getter: <property>type</property>. + * * <p> * Convenience method for returning the <property>type</property> property when it is a {@link JsonTypeArray} value. * @@ -256,8 +263,9 @@ public class Schema { /** * Bean property setter: <property>type</property>. * - * @param type The new value for the <property>type</property> property on this bean. - * This object must be of type {@link JsonType} or {@link JsonTypeArray}. + * @param type + * The new value for the <property>type</property> property on this bean. + * This object must be of type {@link JsonType} or {@link JsonTypeArray}. * @return This object (for method chaining). * @throws BeanRuntimeException If invalid object type passed in. */ @@ -292,12 +300,15 @@ public class Schema { /** * Used during parsing to convert the <property>type</property> property to the correct class type. + * * <ul class='spaced-list'> * <li> * If parsing a JSON-array, converts to a {@link JsonTypeArray}. * <li> * If parsing a JSON-object, converts to a {@link JsonType}. * </ul> + * + * <p> * Serialization method is a no-op. */ public static class JsonTypeOrJsonTypeArraySwap extends PojoSwap<Object,Object> { @@ -321,8 +332,8 @@ public class Schema { /** * Bean property getter: <property>definitions</property>. * - * @return The value of the <property>definitions</property> property on this bean, or <jk>null</jk> if it is not - * set. + * @return + * The value of the <property>definitions</property> property on this bean, or <jk>null</jk> if it is not set. */ public Map<String,Schema> getDefinitions() { return definitions; @@ -367,6 +378,8 @@ public class Schema { /** * Returns the property with the specified name. + * + * <p> * This is equivalent to calling <property>getProperty(name, <jk>false</jk>)</property>. * * @param name The property name. @@ -378,8 +391,10 @@ public class Schema { /** * Returns the property with the specified name. - * If <property>resolve</property> is <jk>true</jk>, the property object will automatically be - * resolved by calling {@link #resolve()}. + * + * <p> + * If <property>resolve</property> is <jk>true</jk>, the property object will automatically be resolved by calling + * {@link #resolve()}. * Therefore, <property>getProperty(name, <jk>true</jk>)</property> is equivalent to calling * <property>getProperty(name).resolve()</property>, except it's safe from a potential * <property>NullPointerException</property>. @@ -418,6 +433,7 @@ public class Schema { /** * Bean property appender: <property>properties</property>. + * * <p> * Properties must have their <property>name</property> property set on them when using this method. * @@ -441,8 +457,9 @@ public class Schema { /** * Bean property getter: <property>patternProperties</property>. * - * @return The value of the <property>patternProperties</property> property on this bean, or <jk>null</jk> if it is - * not set. + * @return + * The value of the <property>patternProperties</property> property on this bean, or <jk>null</jk> if it is + * not set. */ public Map<String,Schema> getPatternProperties() { return patternProperties; @@ -467,6 +484,7 @@ public class Schema { /** * Bean property appender: <property>patternProperties</property>. + * * <p> * Properties must have their <property>name</property> property set to the pattern string when using this method. * @@ -490,8 +508,8 @@ public class Schema { /** * Bean property getter: <property>dependencies</property>. * - * @return The value of the <property>dependencies</property> property on this bean, or <jk>null</jk> if it is not - * set. + * @return + * The value of the <property>dependencies</property> property on this bean, or <jk>null</jk> if it is not set. */ public Map<String,Schema> getDependencies() { return dependencies; @@ -528,8 +546,9 @@ public class Schema { /** * 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. - * Can be either a {@link Schema} or {@link SchemaArray} depending on what value was used to set it. + * @return + * The value of the <property>items</property> property on this bean, or <jk>null</jk> if it is not set. + * Can be either a {@link Schema} or {@link SchemaArray} depending on what value was used to set it. */ @BeanProperty(swap=SchemaOrSchemaArraySwap.class) public Object getItems() { @@ -540,6 +559,7 @@ public class Schema { /** * Bean property getter: <property>items</property>. + * * <p> * Convenience method for returning the <property>items</property> property when it is a {@link Schema} value. * @@ -552,6 +572,7 @@ public class Schema { /** * Bean property getter: <property>items</property>. + * * <p> * Convenience method for returning the <property>items</property> property when it is a {@link SchemaArray} value. * @@ -564,12 +585,15 @@ public class Schema { /** * Used during parsing to convert the <property>items</property> property to the correct class type. + * * <ul class='spaced-list'> * <li> * If parsing a JSON-array, converts to a {@link SchemaArray}. * <li> * If parsing a JSON-object, converts to a {@link Schema}. * </ul> + * + * <p> * Serialization method is a no-op. */ public static class SchemaOrSchemaArraySwap extends PojoSwap<Object,Object> { @@ -593,8 +617,9 @@ public class Schema { /** * Bean property setter: <property>items</property>. * - * @param items The new value for the <property>items</property> property on this bean. - * This object must be of type {@link Schema} or {@link SchemaArray}. + * @param + * items The new value for the <property>items</property> property on this bean. + * This object must be of type {@link Schema} or {@link SchemaArray}. * @return This object (for method chaining). * @throws BeanRuntimeException If invalid object type passed in. */ @@ -673,8 +698,9 @@ public class Schema { /** * 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. + * @return + * The value of the <property>exclusiveMaximum</property> property on this bean, or <jk>null</jk> if it is + * not set. */ public Boolean isExclusiveMaximum() { return exclusiveMaximum; @@ -714,8 +740,9 @@ public class Schema { /** * 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. + * @return + * The value of the <property>exclusiveMinimum</property> property on this bean, or <jk>null</jk> if it is + * not set. */ public Boolean isExclusiveMinimum() { return exclusiveMinimum; @@ -795,9 +822,10 @@ public class Schema { /** * Bean property getter: <property>additionalItems</property>. * - * @return The value of the <property>additionalItems</property> property on this bean, or <jk>null</jk> if it is - * not set. - * Can be either a {@link Boolean} or {@link SchemaArray} depending on what value was used to set it. + * @return + * The value of the <property>additionalItems</property> property on this bean, or <jk>null</jk> if it is + * not set. + * Can be either a {@link Boolean} or {@link SchemaArray} depending on what value was used to set it. */ @BeanProperty(swap=BooleanOrSchemaArraySwap.class) public Object getAdditionalItems() { @@ -808,6 +836,7 @@ public class Schema { /** * Bean property getter: <property>additionalItems</property>. + * * <p> * Convenience method for returning the <property>additionalItems</property> property when it is a {@link Boolean} * value. @@ -821,6 +850,7 @@ public class Schema { /** * Bean property getter: <property>additionalItems</property>. + * * <p> * Convenience method for returning the <property>additionalItems</property> property when it is a * {@link SchemaArray} value. @@ -835,8 +865,9 @@ public class Schema { /** * Bean property setter: <property>additionalItems</property>. * - * @param additionalItems The new value for the <property>additionalItems</property> property on this bean. - * This object must be of type {@link Boolean} or {@link SchemaArray}. + * @param additionalItems + * The new value for the <property>additionalItems</property> property on this bean. + * This object must be of type {@link Boolean} or {@link SchemaArray}. * @return This object (for method chaining). * @throws BeanRuntimeException If invalid object type passed in. */ @@ -860,8 +891,8 @@ public class Schema { /** * Bean property appender: <property>additionalItems</property>. * - * @param additionalItems The list of items to append to the <property>additionalItems</property> property on this - * bean. + * @param additionalItems + * The list of items to append to the <property>additionalItems</property> property on this bean. * @return This object (for method chaining). */ public Schema addAdditionalItems(Schema...additionalItems) { @@ -874,12 +905,15 @@ public class Schema { /** * Used during parsing to convert the <property>additionalItems</property> property to the correct class type. + * * <ul class='spaced-list'> * <li> * If parsing a JSON-array, converts to a {@link SchemaArray}. * <li> * If parsing a JSON-boolean, converts to a {@link Boolean}. * </ul> + * + * <p> * Serialization method is a no-op. */ public static class BooleanOrSchemaArraySwap extends PojoSwap<Object,Object> { @@ -943,8 +977,8 @@ public class Schema { /** * 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. + * @return + * The value of the <property>uniqueItems</property> property on this bean, or <jk>null</jk> if it is not set. */ public Boolean getUniqueItems() { return uniqueItems; @@ -964,8 +998,8 @@ public class Schema { /** * 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. + * @return + * The value of the <property>maxProperties</property> property on this bean, or <jk>null</jk> if it is not set. */ public Integer getMaxProperties() { return maxProperties; @@ -985,8 +1019,8 @@ public class Schema { /** * 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. + * @return + * The value of the <property>minProperties</property> property on this bean, or <jk>null</jk> if it is not set. */ public Integer getMinProperties() { return minProperties; @@ -1068,9 +1102,10 @@ public class Schema { /** * 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. - * Can be either a {@link Boolean} or {@link SchemaArray} depending on what value was used to set it. + * @return + * The value of the <property>additionalProperties</property> property on this bean, or <jk>null</jk> if it + * is not set. + * Can be either a {@link Boolean} or {@link SchemaArray} depending on what value was used to set it. */ @BeanProperty(swap=BooleanOrSchemaSwap.class) public Object getAdditionalProperties() { @@ -1081,6 +1116,7 @@ public class Schema { /** * Bean property getter: <property>additionalProperties</property>. + * * <p> * Convenience method for returning the <property>additionalProperties</property> property when it is a * {@link Boolean} value. @@ -1094,6 +1130,7 @@ public class Schema { /** * Bean property getter: <property>additionalProperties</property>. + * * <p> * Convenience method for returning the <property>additionalProperties</property> property when it is a * {@link Schema} value. @@ -1108,8 +1145,9 @@ public class Schema { /** * Bean property setter: <property>additionalProperties</property>. * - * @param additionalProperties The new value for the <property>additionalProperties</property> property on this bean. - * This object must be of type {@link Boolean} or {@link Schema}. + * @param additionalProperties + * The new value for the <property>additionalProperties</property> property on this bean. + * This object must be of type {@link Boolean} or {@link Schema}. * @return This object (for method chaining). * @throws BeanRuntimeException If invalid object type passed in. */ @@ -1133,12 +1171,15 @@ public class Schema { /** * Used during parsing to convert the <property>additionalProperties</property> property to the correct class type. + * * <ul class='spaced-list'> * <li> * If parsing a JSON-object, converts to a {@link Schema}. * <li> * If parsing a JSON-boolean, converts to a {@link Boolean}. * </ul> + * + * <p> * Serialization method is a no-op. */ public static class BooleanOrSchemaSwap extends PojoSwap<Object,Object> { @@ -1334,9 +1375,11 @@ public class Schema { /** * Bean property setter: <property>$ref</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. * @@ -1374,9 +1417,10 @@ public class Schema { /** * Sets the master schema for this schema and all child schema objects. + * * <p> - * All child elements in a schema should point to a single "master" schema in order to - * locate registered SchemaMap objects for resolving external schemas. + * All child elements in a schema should point to a single "master" schema in order to locate registered SchemaMap + * objects for resolving external schemas. * * @param master The master schema to associate on this and all children. Can be <jk>null</jk>. */ @@ -1417,10 +1461,12 @@ public class Schema { not.setMaster(master); } /** - * If this schema is a reference to another schema (i.e. has its <property>$ref</property> property set), - * this method will retrieve the referenced schema from the schema map registered with this schema. - * If this schema is not a reference, or no schema map is registered with this schema, this method - * is a no-op and simply returns this object. + * If this schema is a reference to another schema (i.e. has its <property>$ref</property> property set), this + * method will retrieve the referenced schema from the schema map registered with this schema. + * + * <p> + * If this schema is not a reference, or no schema map is registered with this schema, this method is a no-op and + * simply returns this object. * * @return The referenced schema, or <jk>null</jk>. */ @@ -1431,8 +1477,8 @@ public class Schema { } /** - * Associates a schema map with this schema for resolving other schemas identified - * through <property>$ref</property> properties. + * Associates a schema map with this schema for resolving other schemas identified through <property>$ref</property> + * properties. * * @param schemaMap The schema map to associate with this schema. Can be <jk>null</jk>. * @return This object (for method chaining).
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaMap.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaMap.java b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaMap.java index 9338a5c..46e72ff 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaMap.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaMap.java @@ -22,6 +22,7 @@ import org.apache.juneau.json.*; /** * A container for retrieving JSON {@link Schema} objects by URI. + * * <p> * Subclasses must implement one of the following methods to load schemas from external sources: * <ul class='spaced-list'> @@ -52,10 +53,14 @@ public abstract class SchemaMap extends ConcurrentHashMap<URI,Schema> { /** * Return the {@link Schema} object at the specified URI. + * + * <p> * If this schema object has not been loaded yet, calls {@link #load(URI)}. + * * <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. * @@ -81,6 +86,7 @@ public abstract class SchemaMap extends ConcurrentHashMap<URI,Schema> { /** * Convenience method for pre-populating this map with the specified schemas. + * * <p> * The schemas passed in through this method MUST have their ID properties set. * @@ -100,7 +106,10 @@ public abstract class SchemaMap extends ConcurrentHashMap<URI,Schema> { /** * Subclasses must implement either this method or {@link #getReader(URI)} to load the schema with the specified URI. + * + * <p> * It's up to the implementer to decide where these come from. + * * <p> * The default implementation calls {@link #getReader(URI)} and parses the schema document. * If {@link #getReader(URI)} returns <jk>null</jk>, this method returns <jk>null</jk> indicating this is an @@ -128,7 +137,10 @@ public abstract class SchemaMap extends ConcurrentHashMap<URI,Schema> { /** * Subclasses must implement either this method or {@link #load(URI)} to load the schema with the specified URI. + * + * <p> * It's up to the implementer to decide where these come from. + * * <p> * The default implementation returns <jk>null</jk>. * http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.java b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.java index 1abd7a6..ced1eaf 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.java @@ -14,6 +14,7 @@ package org.apache.juneau.dto.jsonschema; /** * Convenience class for representing a property that's an array of simple types. + * * <p> * An instance of this object is equivalent to calling... * http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaRef.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaRef.java b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaRef.java index 57ed39e..080cb52 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaRef.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaRef.java @@ -18,6 +18,7 @@ import org.apache.juneau.*; /** * Convenience class for representing a schema reference such as <js>"{'$ref':'/url/to/ref'}"</js>. + * * <p> * An instance of this object is equivalent to calling... * @@ -44,9 +45,11 @@ public class SchemaRef extends Schema { /** * Constructor. + * * <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. * http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Contact.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Contact.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Contact.java index 2948d01..b08e4ba 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Contact.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Contact.java @@ -57,6 +57,7 @@ public class Contact extends SwaggerElement { /** * Bean property getter: <property>name</property>. + * * <p> * The identifying name of the contact person/organization. * @@ -68,6 +69,7 @@ public class Contact extends SwaggerElement { /** * Bean property setter: <property>name</property>. + * * <p> * The identifying name of the contact person/organization. * @@ -91,6 +93,7 @@ public class Contact extends SwaggerElement { /** * Bean property getter: <property>url</property>. + * * <p> * The URL pointing to the contact information. MUST be in the format of a URL. * @@ -102,9 +105,11 @@ public class Contact 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. * @@ -128,6 +133,7 @@ public class Contact extends SwaggerElement { /** * Bean property getter: <property>email</property>. + * * <p> * The email address of the contact person/organization. MUST be in the format of an email address. * @@ -139,6 +145,7 @@ public class Contact extends SwaggerElement { /** * Bean property setter: <property>email</property>. + * * <p> * The email address of the contact person/organization. MUST be in the format of an email address. * http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ExternalDocumentation.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ExternalDocumentation.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ExternalDocumentation.java index 24f556c..e1485e9 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ExternalDocumentation.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ExternalDocumentation.java @@ -55,11 +55,12 @@ public class ExternalDocumentation extends SwaggerElement { /** * Bean property getter: <property>description</property>. + * * <p> * A short description of the target documentation. 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. + * @return + * The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set. */ public String getDescription() { return description; @@ -67,6 +68,7 @@ public class ExternalDocumentation extends SwaggerElement { /** * Bean property setter: <property>description</property>. + * * <p> * A short description of the target documentation. GFM syntax can be used for rich text representation. * @@ -90,11 +92,14 @@ public class ExternalDocumentation extends SwaggerElement { /** * Bean property getter: <property>url</property>. + * * <p> * Required. The URL for the target documentation. + * * <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. * @@ -106,9 +111,11 @@ public class ExternalDocumentation 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. * http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java index c6b31c2..fe97c08 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java @@ -79,11 +79,12 @@ 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. + * @return + * The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set. */ public String getDescription() { return description; @@ -91,6 +92,7 @@ public class HeaderInfo extends SwaggerElement { /** * Bean property setter: <property>description</property>. + * * <p> * A short description of the header. * @@ -114,6 +116,7 @@ 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 < @@ -127,6 +130,7 @@ 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 @@ -156,9 +160,11 @@ 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. + * 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. */ @@ -168,9 +174,11 @@ 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. + * 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). @@ -192,6 +200,7 @@ 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. @@ -204,6 +213,7 @@ 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. @@ -228,9 +238,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>. @@ -238,10 +250,12 @@ 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. + * @return + * The value of the <property>collectionFormat</property> property on this bean, or <jk>null</jk> if it is not set. */ public String getCollectionFormat() { return collectionFormat; @@ -249,8 +263,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> @@ -259,6 +275,7 @@ 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>. * @@ -286,6 +303,7 @@ 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.) @@ -301,6 +319,7 @@ 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.) @@ -328,6 +347,7 @@ 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>. @@ -340,6 +360,7 @@ 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>. @@ -364,6 +385,7 @@ 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>. @@ -377,6 +399,7 @@ 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>. @@ -401,6 +424,7 @@ 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>. @@ -413,6 +437,7 @@ 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>. @@ -437,6 +462,7 @@ 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>. @@ -450,6 +476,7 @@ 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>. @@ -474,6 +501,7 @@ 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>. @@ -486,6 +514,7 @@ 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>. @@ -510,6 +539,7 @@ 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>. @@ -522,6 +552,7 @@ 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>. @@ -535,7 +566,6 @@ public class HeaderInfo extends SwaggerElement { } /** - * * @param minLength The new value for the <property>minLength</property> property on this bean. * @return This object (for method chaining). */ @@ -545,6 +575,7 @@ 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>. @@ -557,6 +588,7 @@ 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>. @@ -581,6 +613,7 @@ 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>. @@ -593,6 +626,7 @@ 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>. @@ -617,6 +651,7 @@ 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>. @@ -629,6 +664,7 @@ 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>. @@ -653,6 +689,7 @@ 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>. @@ -665,6 +702,7 @@ 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>. @@ -689,6 +727,7 @@ 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>. @@ -701,6 +740,7 @@ 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>. @@ -715,12 +755,14 @@ 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. + * @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). */ public HeaderInfo addEnum(Object..._enum) { @@ -750,6 +792,7 @@ 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>. @@ -762,6 +805,7 @@ 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>. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Info.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Info.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Info.java index 4af69c8..d31d8b6 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Info.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Info.java @@ -65,6 +65,7 @@ public class Info extends SwaggerElement { /** * Bean property getter: <property>title</property>. + * * <p> * Required. The title of the application. * @@ -76,6 +77,7 @@ public class Info extends SwaggerElement { /** * Bean property setter: <property>title</property>. + * * <p> * Required. The title of the application. * @@ -99,11 +101,12 @@ 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. + * @return + * The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set. */ public String getDescription() { return description; @@ -111,6 +114,7 @@ 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. * @@ -134,6 +138,7 @@ public class Info extends SwaggerElement { /** * Bean property getter: <property>termsOfService</property>. + * * <p> * The Terms of Service for the API. * @@ -146,6 +151,7 @@ public class Info extends SwaggerElement { /** * Bean property setter: <property>termsOfService</property>. + * * <p> * The Terms of Service for the API. * @@ -169,6 +175,7 @@ public class Info extends SwaggerElement { /** * Bean property getter: <property>contact</property>. + * * <p> * The contact information for the exposed API. * @@ -180,6 +187,7 @@ public class Info extends SwaggerElement { /** * Bean property setter: <property>contact</property>. + * * <p> * The contact information for the exposed API. * @@ -203,6 +211,7 @@ public class Info extends SwaggerElement { /** * Bean property getter: <property>license</property>. + * * <p> * The license information for the exposed API. * @@ -214,6 +223,7 @@ public class Info extends SwaggerElement { /** * Bean property setter: <property>license</property>. + * * <p> * The license information for the exposed API. * @@ -237,6 +247,7 @@ 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). * @@ -248,6 +259,7 @@ 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). * http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Items.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Items.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Items.java index 20140fb..b367b87 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Items.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Items.java @@ -78,6 +78,7 @@ 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 @@ -91,6 +92,7 @@ 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 @@ -120,6 +122,7 @@ 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. @@ -132,6 +135,7 @@ 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. @@ -156,6 +160,7 @@ 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. @@ -168,6 +173,7 @@ 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. @@ -192,8 +198,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> @@ -202,11 +210,13 @@ 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. + * @return + * The value of the <property>collectionFormat</property> property on this bean, or <jk>null</jk> if it is + * not set. */ public String getCollectionFormat() { return collectionFormat; @@ -214,8 +224,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> @@ -224,6 +236,7 @@ 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>. * @@ -251,6 +264,7 @@ 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.) @@ -266,6 +280,7 @@ 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.) @@ -293,6 +308,7 @@ 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>. @@ -305,6 +321,7 @@ 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>. @@ -329,12 +346,14 @@ 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. + * @return + * The value of the <property>exclusiveMaximum</property> property on this bean, or <jk>null</jk> if it is + * not set. */ public Boolean getExclusiveMaximum() { return exclusiveMaximum; @@ -342,6 +361,7 @@ 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>. @@ -366,6 +386,7 @@ 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>. @@ -378,6 +399,7 @@ 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>. @@ -402,6 +424,7 @@ 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>. @@ -415,6 +438,7 @@ 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>. @@ -439,6 +463,7 @@ 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>. @@ -451,6 +476,7 @@ 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>. @@ -475,6 +501,7 @@ 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>. @@ -487,6 +514,7 @@ 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>. @@ -511,6 +539,7 @@ 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>. @@ -523,6 +552,7 @@ 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>. @@ -547,6 +577,7 @@ 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>. @@ -559,6 +590,7 @@ 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>. @@ -583,6 +615,7 @@ 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>. @@ -595,6 +628,7 @@ 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>. @@ -619,6 +653,7 @@ 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>. @@ -632,6 +667,7 @@ 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>. @@ -656,6 +692,7 @@ 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>. @@ -668,6 +705,7 @@ 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>. @@ -682,12 +720,14 @@ 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. + * @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). */ public Items addEnum(Object..._enum) { @@ -708,8 +748,9 @@ 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. + * @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). */ public Items _enum(Object..._enum) { @@ -718,6 +759,7 @@ 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>. @@ -730,6 +772,7 @@ 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>. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/swagger/License.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/License.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/License.java index eb28691..3b837ac 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/License.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/License.java @@ -55,6 +55,7 @@ public class License extends SwaggerElement { /** * Bean property getter: <property>name</property>. + * * <p> * Required. The license name used for the API. * @@ -66,6 +67,7 @@ public class License extends SwaggerElement { /** * Bean property setter: <property>name</property>. + * * <p> * Required. The license name used for the API. * @@ -89,11 +91,14 @@ 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. * @@ -105,9 +110,11 @@ 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. * http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Operation.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Operation.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Operation.java index a3901d9..4766b40 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Operation.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Operation.java @@ -112,6 +112,7 @@ 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. @@ -124,6 +125,7 @@ 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. @@ -138,6 +140,7 @@ 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. @@ -151,12 +154,14 @@ 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>. + * @param tags + * The values to add for the <property>tags</property> property on this bean. + * Ignored if <jk>null</jk>. * @return This object (for method chaining). */ public Operation addTags(Collection<String> tags) { @@ -190,6 +195,7 @@ 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. @@ -202,6 +208,7 @@ 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. @@ -226,13 +233,14 @@ 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. + * @return + * The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set. */ public String getDescription() { return description; @@ -240,6 +248,7 @@ 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 @@ -265,11 +274,12 @@ 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. + * @return + * The value of the <property>externalDocs</property> property on this bean, or <jk>null</jk> if it is not set. */ public ExternalDocumentation getExternalDocs() { return externalDocs; @@ -277,6 +287,7 @@ public class Operation extends SwaggerElement { /** * Bean property setter: <property>externalDocs</property>. + * * <p> * Additional external documentation for this operation. * @@ -300,13 +311,14 @@ 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. + * @return + * The value of the <property>operationId</property> property on this bean, or <jk>null</jk> if it is not set. */ public String getOperationId() { return operationId; @@ -314,6 +326,7 @@ 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 @@ -339,12 +352,12 @@ 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>. + * 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. */ @@ -354,12 +367,12 @@ 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>. + * 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). @@ -371,12 +384,12 @@ 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>. + * 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). @@ -387,12 +400,12 @@ 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>. + * 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). @@ -428,12 +441,12 @@ 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>. + * 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. */ @@ -443,12 +456,12 @@ 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>. + * 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). @@ -460,12 +473,12 @@ 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>. + * 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). @@ -481,12 +494,12 @@ 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>. + * 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). @@ -522,6 +535,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" @@ -529,10 +543,8 @@ public class Operation extends SwaggerElement { * but can never remove it. * The list MUST NOT include duplicated parameters. * A unique parameter is defined by a combination of a <code>name</code> and <code>location</code>. - * 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>. + * 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. @@ -543,6 +555,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" @@ -566,6 +579,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" @@ -611,6 +625,7 @@ 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. * @@ -622,6 +637,7 @@ 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. * @@ -635,6 +651,7 @@ 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. * @@ -672,6 +689,7 @@ 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>. @@ -685,6 +703,7 @@ 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>. @@ -700,6 +719,7 @@ 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>. @@ -714,6 +734,7 @@ 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>. @@ -741,6 +762,7 @@ 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. @@ -754,6 +776,7 @@ 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. @@ -779,6 +802,7 @@ 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 @@ -794,6 +818,7 @@ 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 @@ -811,6 +836,7 @@ 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 @@ -832,8 +858,9 @@ 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 between the security requirements). + * @param alternatives + * The list of values describes alternative security schemes that can be used (that is, there is a logical OR + * between the security requirements). * @return This object (for method chaining). */ public Operation security(String scheme, String...alternatives) {
