http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/997ed946/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PreviousValueDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PreviousValueDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PreviousValueDTO.java index 458a2b3..132456c 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PreviousValueDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PreviousValueDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.Date; import javax.xml.bind.annotation.XmlType; import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter; @@ -34,6 +35,9 @@ public class PreviousValueDTO { /** * @return previous value */ + @ApiModelProperty( + value = "The previous value." + ) public String getPreviousValue() { return previousValue; } @@ -46,6 +50,9 @@ public class PreviousValueDTO { * @return when it was modified */ @XmlJavaTypeAdapter(DateTimeAdapter.class) + @ApiModelProperty( + value = "The timestamp when the value was modified." + ) public Date getTimestamp() { return timestamp; } @@ -57,6 +64,9 @@ public class PreviousValueDTO { /** * @return user who changed the previous value */ + @ApiModelProperty( + value = "The user who changed the previous value." + ) public String getUserName() { return userName; }
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/997ed946/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ProcessGroupDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ProcessGroupDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ProcessGroupDTO.java index f9a6551..93c4ea9 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ProcessGroupDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ProcessGroupDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto; +import com.wordnik.swagger.annotations.ApiModelProperty; import javax.xml.bind.annotation.XmlType; /** @@ -51,6 +52,9 @@ public class ProcessGroupDTO extends NiFiComponentDTO { * * @return The name of this Process Group */ + @ApiModelProperty( + value = "The name of the process group." + ) public String getName() { return name; } @@ -64,6 +68,9 @@ public class ProcessGroupDTO extends NiFiComponentDTO { * * @return This Process Group's parent */ + @ApiModelProperty( + value = "The part of the process group." + ) public ProcessGroupDTO getParent() { return parent; } @@ -75,6 +82,9 @@ public class ProcessGroupDTO extends NiFiComponentDTO { /** * @return comments for this process group */ + @ApiModelProperty( + value = "The comments for the process group." + ) public String getComments() { return comments; } @@ -86,6 +96,9 @@ public class ProcessGroupDTO extends NiFiComponentDTO { /** * @return contents of this process group. This field will be populated if the request is marked verbose */ + @ApiModelProperty( + value = "The contents of this process group. This field will be populated if the request is marked verbose." + ) public FlowSnippetDTO getContents() { return contents; } @@ -97,6 +110,9 @@ public class ProcessGroupDTO extends NiFiComponentDTO { /** * @return number of input ports contained in this process group */ + @ApiModelProperty( + value = "The number of input ports in the process group." + ) public Integer getInputPortCount() { return inputPortCount; } @@ -108,6 +124,9 @@ public class ProcessGroupDTO extends NiFiComponentDTO { /** * @return number of invalid components in this process group */ + @ApiModelProperty( + value = "The number of invalid components in the process group." + ) public Integer getInvalidCount() { return invalidCount; } @@ -119,6 +138,9 @@ public class ProcessGroupDTO extends NiFiComponentDTO { /** * @return number of output ports in this process group */ + @ApiModelProperty( + value = "The number of output ports in the process group." + ) public Integer getOutputPortCount() { return outputPortCount; } @@ -130,6 +152,9 @@ public class ProcessGroupDTO extends NiFiComponentDTO { /** * @return Used in requests, indicates whether this process group should be running */ + @ApiModelProperty( + value = "Used in requests, indicates whether the process group should be running." + ) public Boolean isRunning() { return running; } @@ -141,6 +166,9 @@ public class ProcessGroupDTO extends NiFiComponentDTO { /** * @return number of running component in this process group */ + @ApiModelProperty( + value = "The number of running componetns in this process group." + ) public Integer getRunningCount() { return runningCount; } @@ -152,6 +180,9 @@ public class ProcessGroupDTO extends NiFiComponentDTO { /** * @return number of stopped components in this process group */ + @ApiModelProperty( + value = "The number of stopped components in the process group." + ) public Integer getStoppedCount() { return stoppedCount; } @@ -163,6 +194,9 @@ public class ProcessGroupDTO extends NiFiComponentDTO { /** * @return number of disabled components in this process group */ + @ApiModelProperty( + value = "The number of disabled components in the process group." + ) public Integer getDisabledCount() { return disabledCount; } @@ -174,6 +208,9 @@ public class ProcessGroupDTO extends NiFiComponentDTO { /** * @return number of active remote ports in this process group */ + @ApiModelProperty( + value = "The number of active remote ports in the process group." + ) public Integer getActiveRemotePortCount() { return activeRemotePortCount; } @@ -185,6 +222,9 @@ public class ProcessGroupDTO extends NiFiComponentDTO { /** * @return number of inactive remote ports in this process group */ + @ApiModelProperty( + value = "The number of inactive remote ports in the process group." + ) public Integer getInactiveRemotePortCount() { return inactiveRemotePortCount; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/997ed946/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ProcessorConfigDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ProcessorConfigDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ProcessorConfigDTO.java index 1832ce3..ec5df96 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ProcessorConfigDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ProcessorConfigDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.Map; import java.util.Set; @@ -58,6 +59,9 @@ public class ProcessorConfigDTO { * * @return The scheduling period */ + @ApiModelProperty( + value = "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." + ) public String getSchedulingPeriod() { return schedulingPeriod; } @@ -71,6 +75,9 @@ public class ProcessorConfigDTO { * * @return scheduling strategy */ + @ApiModelProperty( + value = "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." + ) public String getSchedulingStrategy() { return schedulingStrategy; } @@ -80,8 +87,11 @@ public class ProcessorConfigDTO { } /** - * @return the amount of time that is used when this processor penalizes a flow file + * @return the amount of time that is used when this processor penalizes a flowfile */ + @ApiModelProperty( + value = "The amout of time that is used when the process penalizes a flowfile." + ) public String getPenaltyDuration() { return penaltyDuration; } @@ -91,8 +101,11 @@ public class ProcessorConfigDTO { } /** - * @return amount of time must elaspe before this processor is scheduled again when yielding + * @return amount of time must elapse before this processor is scheduled again when yielding */ + @ApiModelProperty( + value = "The amount of time that must elapse before this processor is scheduled again after yielding." + ) public String getYieldDuration() { return yieldDuration; } @@ -104,6 +117,9 @@ public class ProcessorConfigDTO { /** * @return the level at this this processor will report bulletins */ + @ApiModelProperty( + value = "The level at which the processor will report bulletins." + ) public String getBulletinLevel() { return bulletinLevel; } @@ -117,6 +133,9 @@ public class ProcessorConfigDTO { * * @return the concurrently schedulable task count */ + @ApiModelProperty( + value = "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." + ) public Integer getConcurrentlySchedulableTaskCount() { return concurrentlySchedulableTaskCount; } @@ -128,6 +147,9 @@ public class ProcessorConfigDTO { /** * @return whether or not this Processor is Loss Tolerant */ + @ApiModelProperty( + value = "Whether the processor is loss tolerant." + ) public Boolean isLossTolerant() { return lossTolerant; } @@ -139,6 +161,9 @@ public class ProcessorConfigDTO { /** * @return the comments */ + @ApiModelProperty( + value = "The comments for the processor." + ) public String getComments() { return comments; } @@ -153,6 +178,9 @@ public class ProcessorConfigDTO { * * @return The optional properties */ + @ApiModelProperty( + value = "The properties for the processor. Properties whose value is not set will only contain the property name." + ) public Map<String, String> getProperties() { return properties; } @@ -164,6 +192,9 @@ public class ProcessorConfigDTO { /** * @return descriptors for this processor's properties */ + @ApiModelProperty( + value = "Descriptors for the processor's properties." + ) public Map<String, PropertyDescriptorDTO> getDescriptors() { return descriptors; } @@ -177,6 +208,9 @@ public class ProcessorConfigDTO { * * @return The annotation data */ + @ApiModelProperty( + value = "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." + ) public String getAnnotationData() { return annotationData; } @@ -188,6 +222,9 @@ public class ProcessorConfigDTO { /** * @return the URL for this processors custom configuration UI if applicable. Null otherwise. */ + @ApiModelProperty( + value = "The URL for the processor's custom configuration UI if applicable." + ) public String getCustomUiUrl() { return customUiUrl; } @@ -199,6 +236,9 @@ public class ProcessorConfigDTO { /** * @return the names of all processor relationships that cause a flow file to be terminated if the relationship is not connected to anything */ + @ApiModelProperty( + value = "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere." + ) public Set<String> getAutoTerminatedRelationships() { return autoTerminatedRelationships; } @@ -210,6 +250,9 @@ public class ProcessorConfigDTO { /** * @return maps default values for concurrent tasks for each applicable scheduling strategy. */ + @ApiModelProperty( + value = "Maps default values for concurrent tasks for each applicable scheduling strategy." + ) public Map<String, String> getDefaultConcurrentTasks() { return defaultConcurrentTasks; } @@ -221,6 +264,9 @@ public class ProcessorConfigDTO { /** * @return run duration in milliseconds */ + @ApiModelProperty( + value = "The run duration for the processor in milliseconds." + ) public Long getRunDurationMillis() { return runDurationMillis; } @@ -232,6 +278,9 @@ public class ProcessorConfigDTO { /** * @return Maps default values for scheduling period for each applicable scheduling strategy */ + @ApiModelProperty( + value = "Maps default values for scheduling period for each applicable scheduling strategy." + ) public Map<String, String> getDefaultSchedulingPeriod() { return defaultSchedulingPeriod; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/997ed946/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ProcessorDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ProcessorDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ProcessorDTO.java index b80db70..c65c46a 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ProcessorDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ProcessorDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.Collection; import java.util.List; import java.util.Map; @@ -49,6 +50,9 @@ public class ProcessorDTO extends NiFiComponentDTO { * * @return This processors name */ + @ApiModelProperty( + value = "The name of the processor." + ) public String getName() { return name; } @@ -62,6 +66,9 @@ public class ProcessorDTO extends NiFiComponentDTO { * * @return This processors type */ + @ApiModelProperty( + value = "The type of the processor." + ) public String getType() { return type; } @@ -73,6 +80,10 @@ public class ProcessorDTO extends NiFiComponentDTO { /** * @return The state of this processor. Possible states are 'RUNNING', 'STOPPED', and 'DISABLED' */ + @ApiModelProperty( + value = "The state of the processor", + allowableValues = "RUNNING, STOPPED, DISABLED" + ) public String getState() { return state; } @@ -84,6 +95,9 @@ public class ProcessorDTO extends NiFiComponentDTO { /** * @return The styles for this processor. (Currently only supports color) */ + @ApiModelProperty( + value = "Styles for the processor (background-color => #eee)." + ) public Map<String, String> getStyle() { return style; } @@ -95,6 +109,9 @@ public class ProcessorDTO extends NiFiComponentDTO { /** * @return whether this processor supports parallel processing */ + @ApiModelProperty( + value = "Whether the processor supports parallel processing." + ) public Boolean getSupportsParallelProcessing() { return supportsParallelProcessing; } @@ -106,6 +123,9 @@ public class ProcessorDTO extends NiFiComponentDTO { /** * @return whether this processor supports event driven scheduling */ + @ApiModelProperty( + value = "Whether the processor supports event driven scheduling." + ) public Boolean getSupportsEventDriven() { return supportsEventDriven; } @@ -119,6 +139,9 @@ public class ProcessorDTO extends NiFiComponentDTO { * * @return The available relationships */ + @ApiModelProperty( + value = "The available relationships that the processor currently supports." + ) public List<RelationshipDTO> getRelationships() { return relationships; } @@ -132,6 +155,9 @@ public class ProcessorDTO extends NiFiComponentDTO { * * @return The processor configuration details */ + @ApiModelProperty( + value = "The configuration details for the processor. These details will be included in a resopnse if the verbose flag is included in a request." + ) public ProcessorConfigDTO getConfig() { return config; } @@ -145,6 +171,9 @@ public class ProcessorDTO extends NiFiComponentDTO { * * @return The validation errors */ + @ApiModelProperty( + value = "The validation errors for the processor. These validation errors represent the problems with the processor that must be resolved before it can be started." + ) public Collection<String> getValidationErrors() { return validationErrors; } @@ -156,6 +185,9 @@ public class ProcessorDTO extends NiFiComponentDTO { /** * @return the description for this processor */ + @ApiModelProperty( + value = "The description of the processor." + ) public String getDescription() { return description; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/997ed946/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PropertyDescriptorDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PropertyDescriptorDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PropertyDescriptorDTO.java index 02a55a7..dae16f2 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PropertyDescriptorDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PropertyDescriptorDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.List; import javax.xml.bind.annotation.XmlType; @@ -39,6 +40,9 @@ public class PropertyDescriptorDTO { /** * @return set of allowable values for this property. If empty then the allowable values are not constrained */ + @ApiModelProperty( + value = "Allowable values for the property. If empty then the allowed values are not constrained." + ) public List<AllowableValueDTO> getAllowableValues() { return allowableValues; } @@ -50,6 +54,9 @@ public class PropertyDescriptorDTO { /** * @return default value for this property */ + @ApiModelProperty( + value = "The default value for the property." + ) public String getDefaultValue() { return defaultValue; } @@ -61,6 +68,9 @@ public class PropertyDescriptorDTO { /** * @return An explanation of the meaning of the given property. This description is meant to be displayed to a user or simply provide a mechanism of documenting intent */ + @ApiModelProperty( + value = "The descriptoin for the property. Used to relay additional details to a user or provide a mechanism of documenting intent." + ) public String getDescription() { return description; } @@ -72,6 +82,9 @@ public class PropertyDescriptorDTO { /** * @return property name */ + @ApiModelProperty( + value = "The name for the property." + ) public String getName() { return name; } @@ -83,6 +96,9 @@ public class PropertyDescriptorDTO { /** * @return human-readable name to display to users */ + @ApiModelProperty( + value = "The human readable name for the property." + ) public String getDisplayName() { return displayName; } @@ -94,6 +110,9 @@ public class PropertyDescriptorDTO { /** * @return whether the property is required for this processor */ + @ApiModelProperty( + value = "Whether the property is required." + ) public boolean isRequired() { return required; } @@ -105,6 +124,9 @@ public class PropertyDescriptorDTO { /** * @return indicates that the value for this property should be considered sensitive and protected whenever stored or represented */ + @ApiModelProperty( + value = "Whether the property is sensitive and protected whenever stored or represented." + ) public boolean isSensitive() { return sensitive; } @@ -116,6 +138,9 @@ public class PropertyDescriptorDTO { /** * @return indicates whether this property is dynamic */ + @ApiModelProperty( + value = "Whether the property is dynamic (user-defined)." + ) public boolean isDynamic() { return dynamic; } @@ -127,6 +152,9 @@ public class PropertyDescriptorDTO { /** * @return specifies whether or not this property support expression language */ + @ApiModelProperty( + value = "Whether the property supports expression language." + ) public boolean getSupportsEl() { return supportsEl; } @@ -138,6 +166,9 @@ public class PropertyDescriptorDTO { /** * @return if this property identifies a controller service, this returns the fully qualified type, null otherwise */ + @ApiModelProperty( + value = "If the property identifies a controller service, this returns the fully qualified type." + ) public String getIdentifiesControllerService() { return identifiesControllerService; } @@ -159,6 +190,9 @@ public class PropertyDescriptorDTO { /** * @return the human-readable value that is allowed for this PropertyDescriptor */ + @ApiModelProperty( + value = "A human readable value that is allowed for the property descriptor." + ) public String getDisplayName() { return displayName; } @@ -170,6 +204,9 @@ public class PropertyDescriptorDTO { /** * @return the value for this allowable value */ + @ApiModelProperty( + value = "A value that is allowed for the property descriptor." + ) public String getValue() { return value; } @@ -181,6 +218,9 @@ public class PropertyDescriptorDTO { /** * @return a description of this Allowable Value, or <code>null</code> if no description is given */ + @ApiModelProperty( + value = "A description for this allowable value." + ) public String getDescription() { return description; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/997ed946/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PropertyHistoryDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PropertyHistoryDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PropertyHistoryDTO.java index 5dc5b99..35c8293 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PropertyHistoryDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PropertyHistoryDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.List; import javax.xml.bind.annotation.XmlType; @@ -30,6 +31,9 @@ public class PropertyHistoryDTO { /** * @return previous values */ + @ApiModelProperty( + value = "Previous values for a given property." + ) public List<PreviousValueDTO> getPreviousValues() { return previousValues; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/997ed946/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RelationshipDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RelationshipDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RelationshipDTO.java index a9fbfc6..ff5729a 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RelationshipDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RelationshipDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto; +import com.wordnik.swagger.annotations.ApiModelProperty; import javax.xml.bind.annotation.XmlType; /** @@ -31,6 +32,9 @@ public class RelationshipDTO { /** * @return the relationship name */ + @ApiModelProperty( + value = "The relationship name." + ) public String getName() { return name; } @@ -42,6 +46,9 @@ public class RelationshipDTO { /** * @return the relationship description */ + @ApiModelProperty( + value = "The relationship description." + ) public String getDescription() { return description; } @@ -53,6 +60,9 @@ public class RelationshipDTO { /** * @return true if relationship is auto terminated;false otherwise */ + @ApiModelProperty( + value = "Whether or not flowfiles sent to this relationship should auto terminate." + ) public Boolean isAutoTerminate() { return autoTerminate; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/997ed946/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RemoteProcessGroupContentsDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RemoteProcessGroupContentsDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RemoteProcessGroupContentsDTO.java index 3645eb8..261a844 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RemoteProcessGroupContentsDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RemoteProcessGroupContentsDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.Set; import javax.xml.bind.annotation.XmlType; @@ -31,6 +32,9 @@ public class RemoteProcessGroupContentsDTO { /** * @return Controller Input Ports to which data can be sent */ + @ApiModelProperty( + value = "The input ports to which data can be sent." + ) public Set<RemoteProcessGroupPortDTO> getInputPorts() { return inputPorts; } @@ -42,6 +46,9 @@ public class RemoteProcessGroupContentsDTO { /** * @return Controller Output Ports from which data can be retrieved */ + @ApiModelProperty( + value = "The output ports from which data can be retrieved." + ) public Set<RemoteProcessGroupPortDTO> getOutputPorts() { return outputPorts; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/997ed946/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RemoteProcessGroupDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RemoteProcessGroupDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RemoteProcessGroupDTO.java index b30320a..2e30001 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RemoteProcessGroupDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RemoteProcessGroupDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.Date; import java.util.List; import javax.xml.bind.annotation.XmlType; @@ -69,6 +70,9 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO { /** * @return target uri of this remote process group */ + @ApiModelProperty( + value = "The target URI of the remote process group." + ) public String getTargetUri() { return this.targetUri; } @@ -76,6 +80,9 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO { /** * @param name of this remote process group */ + @ApiModelProperty( + value = "The name of the remote process group." + ) public void setName(final String name) { this.name = name; } @@ -87,6 +94,9 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO { /** * @return Comments for this remote process group */ + @ApiModelProperty( + value = "The comments for the remote process group." + ) public String getComments() { return comments; } @@ -98,6 +108,9 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO { /** * @return any remote authorization issues for this remote process group */ + @ApiModelProperty( + value = "Any remote authorization issues for the remote process group." + ) public List<String> getAuthorizationIssues() { return authorizationIssues; } @@ -109,6 +122,9 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO { /** * @return whether or not this remote process group is actively transmitting */ + @ApiModelProperty( + value = "Whether the remote process group is actively transmitting." + ) public Boolean isTransmitting() { return transmitting; } @@ -120,6 +136,9 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO { /** * @return whether or not the target is running securely */ + @ApiModelProperty( + value = "Whether the target is running securely." + ) public Boolean isTargetSecure() { return targetSecure; } @@ -131,6 +150,9 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO { /** * @return the time period used for the timeout when communicating with this RemoteProcessGroup */ + @ApiModelProperty( + value = "The time period used for the timeout when commicating with the target." + ) public String getCommunicationsTimeout() { return communicationsTimeout; } @@ -140,8 +162,11 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO { } /** - * @return when yielding, this amount of time must elaspe before this remote process group is scheduled again + * @return when yielding, this amount of time must elapse before this remote process group is scheduled again */ + @ApiModelProperty( + value = "When yielding, this amount of time must elapse before the remote process group is scheduled again." + ) public String getYieldDuration() { return yieldDuration; } @@ -153,6 +178,9 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO { /** * @return number of active remote input ports */ + @ApiModelProperty( + value = "The number of active remote input ports." + ) public Integer getActiveRemoteInputPortCount() { return activeRemoteInputPortCount; } @@ -164,6 +192,9 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO { /** * @return number of inactive remote input ports */ + @ApiModelProperty( + value = "The number of inactive remote input ports." + ) public Integer getInactiveRemoteInputPortCount() { return inactiveRemoteInputPortCount; } @@ -175,6 +206,9 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO { /** * @return number of active remote output ports */ + @ApiModelProperty( + value = "The number of acitve remote output ports." + ) public Integer getActiveRemoteOutputPortCount() { return activeRemoteOutputPortCount; } @@ -186,6 +220,9 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO { /** * @return number of inactive remote output ports */ + @ApiModelProperty( + value = "The number of inactive remote output ports." + ) public Integer getInactiveRemoteOutputPortCount() { return inactiveRemoteOutputPortCount; } @@ -197,6 +234,9 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO { /** * @return number of Remote Input Ports currently available in the remote NiFi instance */ + @ApiModelProperty( + value = "The number of remote input ports currently available on the target." + ) public Integer getInputPortCount() { return inputPortCount; } @@ -208,6 +248,9 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO { /** * @return number of Remote Output Ports currently available in the remote NiFi instance */ + @ApiModelProperty( + value = "The number of remote output ports currently available on the target." + ) public Integer getOutputPortCount() { return outputPortCount; } @@ -219,6 +262,9 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO { /** * @return contents of this remote process group. Will contain available input/output ports */ + @ApiModelProperty( + value = "The contents of the remote process group. Will contain available input/output ports." + ) public RemoteProcessGroupContentsDTO getContents() { return contents; } @@ -231,6 +277,9 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO { * @return the flow for this remote group was last refreshed */ @XmlJavaTypeAdapter(DateTimeAdapter.class) + @ApiModelProperty( + value = "The timestamp when this remote process group was last refreshed." + ) public Date getFlowRefreshed() { return flowRefreshed; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/997ed946/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RemoteProcessGroupPortDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RemoteProcessGroupPortDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RemoteProcessGroupPortDTO.java index 07f8ced..e4a8131 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RemoteProcessGroupPortDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RemoteProcessGroupPortDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto; +import com.wordnik.swagger.annotations.ApiModelProperty; import javax.xml.bind.annotation.XmlType; /** @@ -38,6 +39,9 @@ public class RemoteProcessGroupPortDTO { /** * @return comments as configured in the target port */ + @ApiModelProperty( + value = "The comments as configured on the target port." + ) public String getComments() { return comments; } @@ -49,6 +53,9 @@ public class RemoteProcessGroupPortDTO { /** * @return number tasks that may transmit flow files to the target port concurrently */ + @ApiModelProperty( + value = "The number of task that may transmit flowfiles to the target port concurrently." + ) public Integer getConcurrentlySchedulableTaskCount() { return concurrentlySchedulableTaskCount; } @@ -60,6 +67,9 @@ public class RemoteProcessGroupPortDTO { /** * @return id of the target port */ + @ApiModelProperty( + value = "The id of the target port." + ) public String getId() { return id; } @@ -71,6 +81,9 @@ public class RemoteProcessGroupPortDTO { /** * @return id of the remote process group that this port resides in */ + @ApiModelProperty( + value = "The id of the remote process group that the port resides in." + ) public String getGroupId() { return groupId; } @@ -82,6 +95,9 @@ public class RemoteProcessGroupPortDTO { /** * @return name of the target port */ + @ApiModelProperty( + value = "The name of the target port." + ) public String getName() { return name; } @@ -93,6 +109,9 @@ public class RemoteProcessGroupPortDTO { /** * @return whether or not this remote group port is configured for transmission */ + @ApiModelProperty( + value = "Whether the remote port is configured for transmission." + ) public Boolean isTransmitting() { return transmitting; } @@ -104,6 +123,9 @@ public class RemoteProcessGroupPortDTO { /** * @return whether or not flow file are compressed when sent to this target port */ + @ApiModelProperty( + value = "Whether the flowfiles are compressed when sent to the target port." + ) public Boolean getUseCompression() { return useCompression; } @@ -115,6 +137,9 @@ public class RemoteProcessGroupPortDTO { /** * @return whether or not the target port exists */ + @ApiModelProperty( + value = "Whether the target port exists." + ) public Boolean getExists() { return exists; } @@ -126,6 +151,9 @@ public class RemoteProcessGroupPortDTO { /** * @return whether or not the target port is running */ + @ApiModelProperty( + value = "Whether the target port is running." + ) public Boolean isTargetRunning() { return targetRunning; } @@ -137,6 +165,9 @@ public class RemoteProcessGroupPortDTO { /** * @return whether or not this port has either an incoming or outgoing connection */ + @ApiModelProperty( + value = "Whether the port has either an incoming or outgoing connection." + ) public Boolean isConnected() { return connected; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/997ed946/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ReportingTaskDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ReportingTaskDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ReportingTaskDTO.java index 4abba4b..cdc834c 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ReportingTaskDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ReportingTaskDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.Collection; import java.util.Map; @@ -49,6 +50,9 @@ public class ReportingTaskDTO extends NiFiComponentDTO { /** * @return user-defined name of the reporting task */ + @ApiModelProperty( + value = "The name of the reporting task." + ) public String getName() { return name; } @@ -60,6 +64,9 @@ public class ReportingTaskDTO extends NiFiComponentDTO { /** * @return user-defined comments for the reporting task */ + @ApiModelProperty( + value = "The comments of the reporting task." + ) public String getComments() { return comments; } @@ -71,6 +78,9 @@ public class ReportingTaskDTO extends NiFiComponentDTO { /** * @return type of reporting task */ + @ApiModelProperty( + value = "The fully qualified type of the reporting task." + ) public String getType() { return type; } @@ -84,6 +94,9 @@ public class ReportingTaskDTO extends NiFiComponentDTO { * * @return The scheduling period */ + @ApiModelProperty( + value = "The frequency with which to schedule the reporting task. The format of the value willd epend on the valud of the schedulingStrategy." + ) public String getSchedulingPeriod() { return schedulingPeriod; } @@ -95,6 +108,10 @@ public class ReportingTaskDTO extends NiFiComponentDTO { /** * @return current scheduling state of the reporting task */ + @ApiModelProperty( + value = "The state of the reporting task.", + allowableValues = "RUNNING, STOPPED, DISABLED" + ) public String getState() { return state; } @@ -106,6 +123,9 @@ public class ReportingTaskDTO extends NiFiComponentDTO { /** * @return The scheduling strategy that determines how the {@link #getSchedulingPeriod()} value should be interpreted */ + @ApiModelProperty( + value = "The scheduling strategy that determines how the schedulingPeriod value should be interpreted." + ) public String getSchedulingStrategy() { return schedulingStrategy; } @@ -115,8 +135,12 @@ public class ReportingTaskDTO extends NiFiComponentDTO { } /** - * @return Where this service is available. Possible values are CLUSTER_MANAGER_ONLY, NODE_ONLY, BOTH + * @return Where this service is available. Possible values are NCM, NODE */ + @ApiModelProperty( + value = "Where the reporting task is available.", + allowableValues = "NCM, NODE" + ) public String getAvailability() { return availability; } @@ -128,6 +152,9 @@ public class ReportingTaskDTO extends NiFiComponentDTO { /** * @return reporting task's properties */ + @ApiModelProperty( + value = "The properties of the reporting task." + ) public Map<String, String> getProperties() { return properties; } @@ -139,6 +166,9 @@ public class ReportingTaskDTO extends NiFiComponentDTO { /** * @return Map of property name to descriptor */ + @ApiModelProperty( + value = "The descriptors for the reporting tasks properties." + ) public Map<String, PropertyDescriptorDTO> getDescriptors() { return descriptors; } @@ -150,6 +180,9 @@ public class ReportingTaskDTO extends NiFiComponentDTO { /** * @return the URL for this reporting task custom configuration UI if applicable. Null otherwise */ + @ApiModelProperty( + value = "The URL for the custom configuration UI for the reporting task." + ) public String getCustomUiUrl() { return customUiUrl; } @@ -161,6 +194,9 @@ public class ReportingTaskDTO extends NiFiComponentDTO { /** * @return currently configured annotation data for the reporting task */ + @ApiModelProperty( + value = "The anntation data for the repoting task. This is how the custom UI relays configuration to the reporting task." + ) public String getAnnotationData() { return annotationData; } @@ -174,6 +210,10 @@ public class ReportingTaskDTO extends NiFiComponentDTO { * * @return The validation errors */ + @ApiModelProperty( + value = "Gets the validation errors from the reporting task. These validation errors represent the problems with the reporting task that must be resolved before " + + "it can be scheduled to run." + ) public Collection<String> getValidationErrors() { return validationErrors; } @@ -185,6 +225,9 @@ public class ReportingTaskDTO extends NiFiComponentDTO { /** * @return default scheduling period for the different scheduling strategies */ + @ApiModelProperty( + value = "The default scheduling period for the different scheduling strategies." + ) public Map<String, String> getDefaultSchedulingPeriod() { return defaultSchedulingPeriod; } @@ -196,6 +239,9 @@ public class ReportingTaskDTO extends NiFiComponentDTO { /** * @return number of active threads for this reporting task */ + @ApiModelProperty( + value = "The number of active threads for the reporting task." + ) public Integer getActiveThreadCount() { return activeThreadCount; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/997ed946/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RevisionDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RevisionDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RevisionDTO.java index e8f4309..c8ef843 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RevisionDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RevisionDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto; +import com.wordnik.swagger.annotations.ApiModelProperty; import javax.xml.bind.annotation.XmlType; /** @@ -35,6 +36,10 @@ public class RevisionDTO { * * @return The client id */ + @ApiModelProperty( + value = "A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous " + + "nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back" + ) public String getClientId() { return clientId; } @@ -48,6 +53,10 @@ public class RevisionDTO { * * @return The revision */ + @ApiModelProperty( + value = "NiFi employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this " + + "field represents the updated base version." + ) public Long getVersion() { return version; } @@ -59,6 +68,9 @@ public class RevisionDTO { /** * @return The user that last modified the flow */ + @ApiModelProperty( + value = "The user that last modified the flow." + ) public String getLastModifier() { return lastModifier; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/997ed946/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/SnippetDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/SnippetDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/SnippetDTO.java index 810b7be..431df17 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/SnippetDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/SnippetDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.HashSet; import java.util.Set; import javax.xml.bind.annotation.XmlType; @@ -46,6 +47,9 @@ public class SnippetDTO { /** * @return id of this snippet */ + @ApiModelProperty( + value = "The id of the snippet." + ) public String getId() { return id; } @@ -57,6 +61,9 @@ public class SnippetDTO { /** * @return uri of this snippet */ + @ApiModelProperty( + value = "The URI of the snippet." + ) public String getUri() { return uri; } @@ -68,6 +75,9 @@ public class SnippetDTO { /** * @return group id for the components in this snippet */ + @ApiModelProperty( + value = "The group id for the components in the snippet." + ) public String getParentGroupId() { return parentGroupId; } @@ -79,6 +89,11 @@ public class SnippetDTO { /** * @return whether or not this snippet is linked to the underlying data flow */ + @ApiModelProperty( + value = "Whether or not the snippet is linked to the underlying data flow. For instance if linked was set to true and the snippet was deleted " + + "it would also deleted the components in the snippet. If the snippet was not linked, deleting the snippet would only remove the " + + "snippet and leave the component intact." + ) public Boolean isLinked() { return linked; } @@ -91,6 +106,10 @@ public class SnippetDTO { * @return the ids of the connections in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its * contents cannot be modified (these ids are ignored during update requests) */ + @ApiModelProperty( + value = "The ids of the connections in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet " + + "has been created its contents cannot be modified (these ids are ignored during update requests)." + ) public Set<String> getConnections() { return connections; } @@ -103,6 +122,10 @@ public class SnippetDTO { * @return the ids of the funnels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its * contents cannot be modified (these ids are ignored during update requests) */ + @ApiModelProperty( + value = "The ids of the funnels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet " + + "has been created its contents cannot be modified (these ids are ignored during update requests)." + ) public Set<String> getFunnels() { return funnels; } @@ -115,6 +138,10 @@ public class SnippetDTO { * @return the ids of the input port in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its * contents cannot be modified (these ids are ignored during update requests) */ + @ApiModelProperty( + value = "The ids of the input ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet " + + "has been created its contents cannot be modified (these ids are ignored during update requests)." + ) public Set<String> getInputPorts() { return inputPorts; } @@ -127,6 +154,10 @@ public class SnippetDTO { * @return the ids of the labels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its * contents cannot be modified (these ids are ignored during update requests) */ + @ApiModelProperty( + value = "The ids of the labels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet " + + "has been created its contents cannot be modified (these ids are ignored during update requests)." + ) public Set<String> getLabels() { return labels; } @@ -139,6 +170,10 @@ public class SnippetDTO { * @return the ids of the output ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created * its contents cannot be modified (these ids are ignored during update requests) */ + @ApiModelProperty( + value = "The ids of the output ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet " + + "has been created its contents cannot be modified (these ids are ignored during update requests)." + ) public Set<String> getOutputPorts() { return outputPorts; } @@ -151,6 +186,10 @@ public class SnippetDTO { * @return The ids of the process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created * its contents cannot be modified (these ids are ignored during update requests) */ + @ApiModelProperty( + value = "The ids of the process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet " + + "has been created its contents cannot be modified (these ids are ignored during update requests)." + ) public Set<String> getProcessGroups() { return processGroups; } @@ -163,6 +202,10 @@ public class SnippetDTO { * @return The ids of the processors in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its * contents cannot be modified (these ids are ignored during update requests) */ + @ApiModelProperty( + value = "The ids of the processors in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet " + + "has been created its contents cannot be modified (these ids are ignored during update requests)." + ) public Set<String> getProcessors() { return processors; } @@ -175,6 +218,10 @@ public class SnippetDTO { * @return the ids of the remote process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been * created its contents cannot be modified (these ids are ignored during update requests) */ + @ApiModelProperty( + value = "The ids of the remote process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet " + + "has been created its contents cannot be modified (these ids are ignored during update requests)." + ) public Set<String> getRemoteProcessGroups() { return remoteProcessGroups; } @@ -186,6 +233,9 @@ public class SnippetDTO { /** * @return the contents of the configuration for this snippet */ + @ApiModelProperty( + value = "The contents of the configuration for the snippet." + ) public FlowSnippetDTO getContents() { return contents; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/997ed946/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/SystemDiagnosticsDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/SystemDiagnosticsDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/SystemDiagnosticsDTO.java index f39cbaf..d2a9d1a 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/SystemDiagnosticsDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/SystemDiagnosticsDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.Date; import java.util.Set; import javax.xml.bind.annotation.XmlType; @@ -56,6 +57,9 @@ public class SystemDiagnosticsDTO { /** * @return number of available processors, if supported */ + @ApiModelProperty( + value = "Number of available processors if supported by the underlying system." + ) public Integer getAvailableProcessors() { return availableProcessors; } @@ -67,6 +71,9 @@ public class SystemDiagnosticsDTO { /** * @return number of daemon threads */ + @ApiModelProperty( + value = "Number of daemon threads." + ) public Integer getDaemonThreads() { return daemonThreads; } @@ -78,6 +85,9 @@ public class SystemDiagnosticsDTO { /** * @return amount of free heap */ + @ApiModelProperty( + value = "Amount of free heap." + ) public String getFreeHeap() { return freeHeap; } @@ -89,6 +99,9 @@ public class SystemDiagnosticsDTO { /** * @return amount of free non-heap */ + @ApiModelProperty( + value = "Amount of free non heap." + ) public String getFreeNonHeap() { return freeNonHeap; } @@ -100,6 +113,9 @@ public class SystemDiagnosticsDTO { /** * @return max size of the heap */ + @ApiModelProperty( + value = "Maximum size of heap." + ) public String getMaxHeap() { return maxHeap; } @@ -111,6 +127,9 @@ public class SystemDiagnosticsDTO { /** * @return max size of the non-heap */ + @ApiModelProperty( + value = "Maximum size of non heap." + ) public String getMaxNonHeap() { return maxNonHeap; } @@ -122,6 +141,9 @@ public class SystemDiagnosticsDTO { /** * @return processor load average, if supported */ + @ApiModelProperty( + value = "The processor load average if supported by the underlying system." + ) public Double getProcessorLoadAverage() { return processorLoadAverage; } @@ -133,6 +155,9 @@ public class SystemDiagnosticsDTO { /** * @return total size of the heap */ + @ApiModelProperty( + value = "Total size of heap." + ) public String getTotalHeap() { return totalHeap; } @@ -144,6 +169,9 @@ public class SystemDiagnosticsDTO { /** * @return total size of non-heap */ + @ApiModelProperty( + value = "Total size of non heap." + ) public String getTotalNonHeap() { return totalNonHeap; } @@ -155,6 +183,9 @@ public class SystemDiagnosticsDTO { /** * @return total number of threads */ + @ApiModelProperty( + value = "Total number of threads." + ) public Integer getTotalThreads() { return totalThreads; } @@ -166,6 +197,9 @@ public class SystemDiagnosticsDTO { /** * @return amount of used heap */ + @ApiModelProperty( + value = "Amount of used heap." + ) public String getUsedHeap() { return usedHeap; } @@ -177,6 +211,9 @@ public class SystemDiagnosticsDTO { /** * @return amount of used non-heap */ + @ApiModelProperty( + value = "Amount of use non heap." + ) public String getUsedNonHeap() { return usedNonHeap; } @@ -188,6 +225,9 @@ public class SystemDiagnosticsDTO { /** * @return heap utilization */ + @ApiModelProperty( + value = "Utilization of heap." + ) public String getHeapUtilization() { return heapUtilization; } @@ -199,6 +239,9 @@ public class SystemDiagnosticsDTO { /** * @return non-heap utilization */ + @ApiModelProperty( + value = "Utilization of non heap." + ) public String getNonHeapUtilization() { return nonHeapUtilization; } @@ -210,6 +253,9 @@ public class SystemDiagnosticsDTO { /** * @return content repository storage usage */ + @ApiModelProperty( + value = "The content repository storage usage." + ) public Set<StorageUsageDTO> getContentRepositoryStorageUsage() { return contentRepositoryStorageUsage; } @@ -221,6 +267,9 @@ public class SystemDiagnosticsDTO { /** * @return flowfile repository storage usage */ + @ApiModelProperty( + value = "The flowfile repository storage usage." + ) public StorageUsageDTO getFlowFileRepositoryStorageUsage() { return flowFileRepositoryStorageUsage; } @@ -232,6 +281,9 @@ public class SystemDiagnosticsDTO { /** * @return Garbage collection details */ + @ApiModelProperty( + value = "The garbage collection details." + ) public Set<GarbageCollectionDTO> getGarbageCollection() { return garbageCollection; } @@ -244,6 +296,9 @@ public class SystemDiagnosticsDTO { * @return When these diagnostics were generated */ @XmlJavaTypeAdapter(TimeAdapter.class) + @ApiModelProperty( + value = "When the diagnostics were generated." + ) public Date getStatsLastRefreshed() { return statsLastRefreshed; } @@ -270,6 +325,9 @@ public class SystemDiagnosticsDTO { /** * @return identifier for this storage location */ + @ApiModelProperty( + value = "The identifier of this storage location. The identifier will correspond to the identifier keyed in the storage configuration." + ) public String getIdentifier() { return identifier; } @@ -281,6 +339,9 @@ public class SystemDiagnosticsDTO { /** * @return amount of free space */ + @ApiModelProperty( + value = "Amount of free space." + ) public String getFreeSpace() { return freeSpace; } @@ -292,6 +353,9 @@ public class SystemDiagnosticsDTO { /** * @return freeSpace amount of total space */ + @ApiModelProperty( + value = "Amount of total space." + ) public String getTotalSpace() { return totalSpace; } @@ -303,6 +367,9 @@ public class SystemDiagnosticsDTO { /** * @return amount of used space */ + @ApiModelProperty( + value = "Amount of used space." + ) public String getUsedSpace() { return usedSpace; } @@ -314,6 +381,9 @@ public class SystemDiagnosticsDTO { /** * @return utilization of this storage location */ + @ApiModelProperty( + value = "Utilization of this storage location." + ) public String getUtilization() { return utilization; } @@ -325,6 +395,9 @@ public class SystemDiagnosticsDTO { /** * @return number of bytes of free space */ + @ApiModelProperty( + value = "The number of bytes of free space." + ) public Long getFreeSpaceBytes() { return freeSpaceBytes; } @@ -336,6 +409,9 @@ public class SystemDiagnosticsDTO { /** * @return number of bytes of total space */ + @ApiModelProperty( + value = "The number of bytes of total space." + ) public Long getTotalSpaceBytes() { return totalSpaceBytes; } @@ -347,6 +423,9 @@ public class SystemDiagnosticsDTO { /** * @return number of bytes of used space */ + @ApiModelProperty( + value = "The number of bytes of used space." + ) public Long getUsedSpaceBytes() { return usedSpaceBytes; } @@ -369,6 +448,9 @@ public class SystemDiagnosticsDTO { /** * @return name of the garbage collector */ + @ApiModelProperty( + value = "The name of the garbage collector." + ) public String getName() { return name; } @@ -377,6 +459,9 @@ public class SystemDiagnosticsDTO { this.name = name; } + @ApiModelProperty( + value = "The number of times garbage collection has run." + ) public long getCollectionCount() { return collectionCount; } @@ -391,6 +476,9 @@ public class SystemDiagnosticsDTO { /** * @return total amount of time spent garbage collecting */ + @ApiModelProperty( + value = "The total amount of time spent garbage collecting." + ) public String getCollectionTime() { return collectionTime; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/997ed946/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/TemplateDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/TemplateDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/TemplateDTO.java index 635e3e8..6fa9daf 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/TemplateDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/TemplateDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.Date; import javax.xml.bind.annotation.XmlRootElement; import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter; @@ -39,6 +40,9 @@ public class TemplateDTO { /** * @return id for this template */ + @ApiModelProperty( + value = "The id of the template." + ) public String getId() { return id; } @@ -50,6 +54,9 @@ public class TemplateDTO { /** * @return uri for this template */ + @ApiModelProperty( + value = "The URI for the template." + ) public String getUri() { return uri; } @@ -61,6 +68,9 @@ public class TemplateDTO { /** * @return name of this template */ + @ApiModelProperty( + value = "The name of the template." + ) public String getName() { return name; } @@ -72,6 +82,9 @@ public class TemplateDTO { /** * @return description of this template */ + @ApiModelProperty( + value = "The description of the template." + ) public String getDescription() { return description; } @@ -84,6 +97,9 @@ public class TemplateDTO { * @return timestamp when this template was created */ @XmlJavaTypeAdapter(DateTimeAdapter.class) + @ApiModelProperty( + value = "The timestamp when this template was created." + ) public Date getTimestamp() { return timestamp; } @@ -95,6 +111,9 @@ public class TemplateDTO { /** * @return snippet in this template */ + @ApiModelProperty( + value = "The contents of the template." + ) public FlowSnippetDTO getSnippet() { return snippet; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/997ed946/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/UserDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/UserDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/UserDTO.java index 2c56422..3344306 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/UserDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/UserDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.Date; import java.util.Set; import javax.xml.bind.annotation.XmlType; @@ -43,6 +44,9 @@ public class UserDTO { /** * @return user id */ + @ApiModelProperty( + value = "The id of the user." + ) public String getId() { return id; } @@ -54,6 +58,9 @@ public class UserDTO { /** * @return users authorities */ + @ApiModelProperty( + value = "The users authorities." + ) public Set<String> getAuthorities() { return authorities; } @@ -66,6 +73,9 @@ public class UserDTO { * @return creation time for this users account */ @XmlJavaTypeAdapter(DateTimeAdapter.class) + @ApiModelProperty( + value = "The timestamp when the user was created." + ) public Date getCreation() { return creation; } @@ -77,6 +87,9 @@ public class UserDTO { /** * @return users DN */ + @ApiModelProperty( + value = "The dn of the user." + ) public String getDn() { return dn; } @@ -88,6 +101,9 @@ public class UserDTO { /** * @return users name. If the name could not be extracted from the DN, this value will be the entire DN */ + @ApiModelProperty( + value = "The username. If it could not be extracted from the DN, this value will be the entire DN." + ) public String getUserName() { return userName; } @@ -99,6 +115,9 @@ public class UserDTO { /** * @return user group */ + @ApiModelProperty( + value = "The group this user belongs to." + ) public String getUserGroup() { return userGroup; } @@ -110,6 +129,9 @@ public class UserDTO { /** * @return users account justification */ + @ApiModelProperty( + value = "The justification for the user account." + ) public String getJustification() { return justification; } @@ -122,6 +144,9 @@ public class UserDTO { * @return time that the user last accessed the system */ @XmlJavaTypeAdapter(DateTimeAdapter.class) + @ApiModelProperty( + value = "The timestamp the user last accessed the system." + ) public Date getLastAccessed() { return lastAccessed; } @@ -134,6 +159,9 @@ public class UserDTO { * @return time that the users credentials were last verified */ @XmlJavaTypeAdapter(DateTimeAdapter.class) + @ApiModelProperty( + value = "The timestamp the user authorities were verified." + ) public Date getLastVerified() { return lastVerified; } @@ -145,6 +173,9 @@ public class UserDTO { /** * @return status of the users account */ + @ApiModelProperty( + value = "The user status." + ) public String getStatus() { return status; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/997ed946/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/UserGroupDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/UserGroupDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/UserGroupDTO.java index 6c4d224..8f6a3a1 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/UserGroupDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/UserGroupDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.Set; import javax.xml.bind.annotation.XmlType; @@ -33,6 +34,9 @@ public class UserGroupDTO { /** * @return user group */ + @ApiModelProperty( + value = "The user group." + ) public String getGroup() { return group; } @@ -44,6 +48,9 @@ public class UserGroupDTO { /** * @return users in this group */ + @ApiModelProperty( + value = "The users that belong to the group." + ) public Set<String> getUserIds() { return userIds; } @@ -55,6 +62,9 @@ public class UserGroupDTO { /** * @return status of the users account */ + @ApiModelProperty( + value = "The status of the users accounts." + ) public String getStatus() { return status; } @@ -66,6 +76,9 @@ public class UserGroupDTO { /** * @return users authorities */ + @ApiModelProperty( + value = "The authorities of the users." + ) public Set<String> getAuthorities() { return authorities; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/997ed946/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/ActionDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/ActionDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/ActionDTO.java index 357dd0f..d4dea38 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/ActionDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/ActionDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.action; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.Date; import javax.xml.bind.annotation.XmlType; import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter; @@ -45,6 +46,9 @@ public class ActionDTO { /** * @return action id */ + @ApiModelProperty( + value = "The action id." + ) public Integer getId() { return id; } @@ -56,6 +60,9 @@ public class ActionDTO { /** * @return user dn who perform this action */ + @ApiModelProperty( + value = "The dn of the user that performed the action." + ) public String getUserDn() { return userDn; } @@ -67,6 +74,9 @@ public class ActionDTO { /** * @return user name who perform this action */ + @ApiModelProperty( + value = "The name of the user that performed the action." + ) public String getUserName() { return userName; } @@ -79,6 +89,9 @@ public class ActionDTO { * @return action's timestamp */ @XmlJavaTypeAdapter(DateTimeAdapter.class) + @ApiModelProperty( + value = "The timestamp of the action." + ) public Date getTimestamp() { return timestamp; } @@ -90,6 +103,9 @@ public class ActionDTO { /** * @return id of the source component of this action */ + @ApiModelProperty( + value = "The id of the source component." + ) public String getSourceId() { return sourceId; } @@ -101,6 +117,9 @@ public class ActionDTO { /** * @return name of the source component of this action */ + @ApiModelProperty( + value = "The name of the source component." + ) public String getSourceName() { return sourceName; } @@ -112,6 +131,9 @@ public class ActionDTO { /** * @return type of the source component of this action */ + @ApiModelProperty( + value = "The type of the source component." + ) public String getSourceType() { return sourceType; } @@ -123,6 +145,9 @@ public class ActionDTO { /** * @return component details (if any) for this action */ + @ApiModelProperty( + value = "The details of the source component." + ) public ComponentDetailsDTO getComponentDetails() { return componentDetails; } @@ -134,6 +159,9 @@ public class ActionDTO { /** * @return operation being performed in this action */ + @ApiModelProperty( + value = "The operation that was performed." + ) public String getOperation() { return operation; } @@ -145,6 +173,9 @@ public class ActionDTO { /** * @return action details (if any) for this action */ + @ApiModelProperty( + value = "The details of the action." + ) public ActionDetailsDTO getActionDetails() { return actionDetails; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/997ed946/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/HistoryDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/HistoryDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/HistoryDTO.java index 36a5e47..597ef0b 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/HistoryDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/HistoryDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.action; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.Collection; import java.util.Date; import javax.xml.bind.annotation.XmlType; @@ -35,6 +36,9 @@ public class HistoryDTO { /** * @return total number of actions */ + @ApiModelProperty( + value = "The number of number of actions that matched the search criteria.." + ) public Integer getTotal() { return total; } @@ -47,6 +51,9 @@ public class HistoryDTO { * @return timestamp when these records were returned */ @XmlJavaTypeAdapter(TimeAdapter.class) + @ApiModelProperty( + value = "The timestamp when the report was generated." + ) public Date getLastRefreshed() { return lastRefreshed; } @@ -58,6 +65,9 @@ public class HistoryDTO { /** * @return actions for this range */ + @ApiModelProperty( + value = "The actions." + ) public Collection<ActionDTO> getActions() { return actions; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/997ed946/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/HistoryQueryDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/HistoryQueryDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/HistoryQueryDTO.java index 48a1321..7d4d21d 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/HistoryQueryDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/HistoryQueryDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.action; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.Date; import javax.xml.bind.annotation.XmlType; import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter; @@ -39,6 +40,9 @@ public class HistoryQueryDTO { /** * @return user name */ + @ApiModelProperty( + value = "The name of the source component." + ) public String getUserName() { return userName; } @@ -50,6 +54,9 @@ public class HistoryQueryDTO { /** * @return source component id */ + @ApiModelProperty( + value = "The id of the source component." + ) public String getSourceId() { return sourceId; } @@ -62,6 +69,9 @@ public class HistoryQueryDTO { * @return start date */ @XmlJavaTypeAdapter(DateTimeAdapter.class) + @ApiModelProperty( + value = "The start date of actions to return." + ) public Date getStartDate() { return startDate; } @@ -74,6 +84,9 @@ public class HistoryQueryDTO { * @return end date */ @XmlJavaTypeAdapter(DateTimeAdapter.class) + @ApiModelProperty( + value = "The end date of actions to return." + ) public Date getEndDate() { return endDate; } @@ -85,6 +98,9 @@ public class HistoryQueryDTO { /** * @return offset */ + @ApiModelProperty( + value = "The offset into the result set." + ) public Integer getOffset() { return offset; } @@ -96,6 +112,9 @@ public class HistoryQueryDTO { /** * @return desired row count */ + @ApiModelProperty( + value = "The number of actions to return." + ) public Integer getCount() { return count; } @@ -107,6 +126,9 @@ public class HistoryQueryDTO { /** * @return desired sort column */ + @ApiModelProperty( + value = "The field to sort on." + ) public String getSortColumn() { return sortColumn; } @@ -118,6 +140,9 @@ public class HistoryQueryDTO { /** * @return desired sort order */ + @ApiModelProperty( + value = "The sort order." + ) public String getSortOrder() { return sortOrder; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/997ed946/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/component/details/ExtensionDetailsDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/component/details/ExtensionDetailsDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/component/details/ExtensionDetailsDTO.java index 90eb5f0..81f87c1 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/component/details/ExtensionDetailsDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/component/details/ExtensionDetailsDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.action.component.details; +import com.wordnik.swagger.annotations.ApiModelProperty; import javax.xml.bind.annotation.XmlType; /** @@ -29,6 +30,9 @@ public class ExtensionDetailsDTO extends ComponentDetailsDTO { /** * @return extension type */ + @ApiModelProperty( + value = "The fully qualified type of extension." + ) public String getType() { return type; }
