NIFI-292: - Continuing to document/annotate client DTOs. Project: http://git-wip-us.apache.org/repos/asf/incubator-nifi/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-nifi/commit/5984b952 Tree: http://git-wip-us.apache.org/repos/asf/incubator-nifi/tree/5984b952 Diff: http://git-wip-us.apache.org/repos/asf/incubator-nifi/diff/5984b952
Branch: refs/heads/NIFI-292 Commit: 5984b95282a4843d090f8b8b15ce65894ea269e8 Parents: bb95628 Author: Matt Gilman <[email protected]> Authored: Wed Apr 29 16:12:51 2015 -0400 Committer: Matt Gilman <[email protected]> Committed: Wed Apr 29 16:12:51 2015 -0400 ---------------------------------------------------------------------- .../nifi-framework/nifi-client-dto/pom.xml | 7 ++ .../org/apache/nifi/web/api/dto/AboutDTO.java | 7 ++ .../org/apache/nifi/web/api/dto/BannerDTO.java | 7 ++ .../nifi/web/api/dto/BulletinBoardDTO.java | 7 ++ .../apache/nifi/web/api/dto/BulletinDTO.java | 28 +++++++ .../nifi/web/api/dto/BulletinQueryDTO.java | 20 +++++ .../org/apache/nifi/web/api/dto/ClusterDTO.java | 7 ++ .../nifi/web/api/dto/ComponentHistoryDTO.java | 7 ++ .../apache/nifi/web/api/dto/ConnectableDTO.java | 29 +++++++ .../apache/nifi/web/api/dto/ConnectionDTO.java | 51 ++++++++++-- .../web/api/dto/ControllerConfigurationDTO.java | 33 ++++++++ .../apache/nifi/web/api/dto/ControllerDTO.java | 50 +++++++++++ .../nifi/web/api/dto/ControllerServiceDTO.java | 36 ++++++++ ...ontrollerServiceReferencingComponentDTO.java | 40 +++++++++ .../org/apache/nifi/web/api/dto/CounterDTO.java | 16 ++++ .../apache/nifi/web/api/dto/CountersDTO.java | 7 ++ .../nifi/web/api/dto/DocumentedTypeDTO.java | 10 +++ .../apache/nifi/web/api/dto/FlowSnippetDTO.java | 28 +++++++ .../org/apache/nifi/web/api/dto/LabelDTO.java | 15 +++- .../nifi/web/api/dto/NiFiComponentDTO.java | 13 +++ .../org/apache/nifi/web/api/dto/NodeDTO.java | 34 ++++++++ .../apache/nifi/web/api/dto/NodeEventDTO.java | 10 +++ .../web/api/dto/NodeSystemDiagnosticsDTO.java | 7 ++ .../org/apache/nifi/web/api/dto/PortDTO.java | 30 +++++++ .../apache/nifi/web/api/dto/PositionDTO.java | 7 ++ .../nifi/web/api/dto/PreviousValueDTO.java | 10 +++ .../nifi/web/api/dto/ProcessGroupDTO.java | 40 +++++++++ .../nifi/web/api/dto/ProcessorConfigDTO.java | 53 +++++++++++- .../apache/nifi/web/api/dto/ProcessorDTO.java | 32 +++++++ .../nifi/web/api/dto/PropertyDescriptorDTO.java | 40 +++++++++ .../nifi/web/api/dto/PropertyHistoryDTO.java | 4 + .../nifi/web/api/dto/RelationshipDTO.java | 10 +++ .../api/dto/RemoteProcessGroupContentsDTO.java | 7 ++ .../nifi/web/api/dto/RemoteProcessGroupDTO.java | 51 +++++++++++- .../web/api/dto/RemoteProcessGroupPortDTO.java | 31 +++++++ .../nifi/web/api/dto/ReportingTaskDTO.java | 48 ++++++++++- .../apache/nifi/web/api/dto/RevisionDTO.java | 12 +++ .../org/apache/nifi/web/api/dto/SnippetDTO.java | 50 +++++++++++ .../nifi/web/api/dto/SystemDiagnosticsDTO.java | 88 ++++++++++++++++++++ .../apache/nifi/web/api/dto/TemplateDTO.java | 19 +++++ .../org/apache/nifi/web/api/dto/UserDTO.java | 31 +++++++ .../apache/nifi/web/api/dto/UserGroupDTO.java | 13 +++ .../org/apache/nifi/web/api/entity/Entity.java | 4 + 43 files changed, 1039 insertions(+), 10 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/5984b952/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/pom.xml ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/pom.xml b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/pom.xml index 41454a9..3a34460 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/pom.xml +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/pom.xml @@ -41,4 +41,11 @@ </plugin> </plugins> </build> + <dependencies> + <dependency> + <groupId>com.wordnik</groupId> + <artifactId>swagger-annotations</artifactId> + <version>1.5.3-M1</version> + </dependency> + </dependencies> </project> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/5984b952/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/AboutDTO.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/AboutDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/AboutDTO.java index 0e2dcb0..83aad41 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/AboutDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/AboutDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto; +import com.wordnik.swagger.annotations.ApiModelProperty; import javax.xml.bind.annotation.XmlType; /** @@ -33,6 +34,9 @@ public class AboutDTO { * * @return The title */ + @ApiModelProperty( + value = "The title to be used on the page and in the about dialog." + ) public String getTitle() { return title; } @@ -46,6 +50,9 @@ public class AboutDTO { * * @return The version. */ + @ApiModelProperty( + value = "The version of this NiFi." + ) public String getVersion() { return version; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/5984b952/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BannerDTO.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/BannerDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BannerDTO.java index 70c408b..c0a691b 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BannerDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BannerDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto; +import com.wordnik.swagger.annotations.ApiModelProperty; import javax.xml.bind.annotation.XmlType; /** @@ -33,6 +34,9 @@ public class BannerDTO { * * @return The footer text */ + @ApiModelProperty( + value = "The footer text." + ) public String getFooterText() { return footerText; } @@ -46,6 +50,9 @@ public class BannerDTO { * * @return The header text */ + @ApiModelProperty( + value = "The header text." + ) public String getHeaderText() { return headerText; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/5984b952/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinBoardDTO.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/BulletinBoardDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinBoardDTO.java index 5e9440d..455769a 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinBoardDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinBoardDTO.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; @@ -35,6 +36,9 @@ public class BulletinBoardDTO { /** * @return bulletins to populate in the bulletin board */ + @ApiModelProperty( + value = "The bulletins in the bulletin board, that matches the supplied request." + ) public List<BulletinDTO> getBulletins() { return bulletins; } @@ -47,6 +51,9 @@ public class BulletinBoardDTO { * @return when this bulletin board was generated */ @XmlJavaTypeAdapter(TimeAdapter.class) + @ApiModelProperty( + value = "The timestamp when this report was generated." + ) public Date getGenerated() { return generated; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/5984b952/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinDTO.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/BulletinDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinDTO.java index 7ae77bb..4c552f6 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinDTO.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; @@ -40,6 +41,9 @@ public class BulletinDTO { /** * @return id of this message */ + @ApiModelProperty( + value = "The id of the bulletin." + ) public Long getId() { return id; } @@ -51,6 +55,9 @@ public class BulletinDTO { /** * @return When clustered, the address of the node from which this bulletin originated */ + @ApiModelProperty( + value = "If clustered, the address of the node from whicih the bulletin originated." + ) public String getNodeAddress() { return nodeAddress; } @@ -62,6 +69,9 @@ public class BulletinDTO { /** * @return group id of the source component */ + @ApiModelProperty( + value = "The group id of the source component." + ) public String getGroupId() { return groupId; } @@ -73,6 +83,9 @@ public class BulletinDTO { /** * @return category of this message */ + @ApiModelProperty( + value = "The catagory of this bulletin." + ) public String getCategory() { return category; } @@ -84,6 +97,9 @@ public class BulletinDTO { /** * @return actual message */ + @ApiModelProperty( + value = "The bulletin message." + ) public String getMessage() { return message; } @@ -95,6 +111,9 @@ public class BulletinDTO { /** * @return id of the source of this message */ + @ApiModelProperty( + value = "The id of the source component." + ) public String getSourceId() { return sourceId; } @@ -106,6 +125,9 @@ public class BulletinDTO { /** * @return name of the source of this message */ + @ApiModelProperty( + value = "The name of the source component." + ) public String getSourceName() { return sourceName; } @@ -117,6 +139,9 @@ public class BulletinDTO { /** * @return level of this bulletin */ + @ApiModelProperty( + value = "The level of the bulletin." + ) public String getLevel() { return level; } @@ -129,6 +154,9 @@ public class BulletinDTO { * @return When this bulletin was generated as a formatted string */ @XmlJavaTypeAdapter(TimeAdapter.class) + @ApiModelProperty( + value = "When this bulletin was generated." + ) public Date getTimestamp() { return timestamp; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/5984b952/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinQueryDTO.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/BulletinQueryDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinQueryDTO.java index 4b060f1..e47cdf9 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinQueryDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinQueryDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto; +import com.wordnik.swagger.annotations.ApiModelProperty; import javax.xml.bind.annotation.XmlType; /** @@ -34,6 +35,10 @@ public class BulletinQueryDTO { /** * @return Include bulletins after this id */ + @ApiModelProperty( + value = "Will include bulletins that occurred after this id. The ids are a one-up number that are used to ensure bulletins that " + + "occur at the same time will not be missed." + ) public Long getAfter() { return after; } @@ -45,6 +50,9 @@ public class BulletinQueryDTO { /** * @return Include bulletin within this group. Supports a regular expression */ + @ApiModelProperty( + value = "Will include bulletins that occurred within this group. Supports a regular expression." + ) public String getGroupId() { return groupId; } @@ -56,6 +64,9 @@ public class BulletinQueryDTO { /** * @return Include bulletins that match this message. Supports a regular expression */ + @ApiModelProperty( + value = "Will include bulletins that match this message. Supports a regular expression." + ) public String getMessage() { return message; } @@ -67,6 +78,9 @@ public class BulletinQueryDTO { /** * @return Include bulletins that match this name. Supports a regular expression */ + @ApiModelProperty( + value = "Will include bulletins that match this name. Supports a regular expression." + ) public String getName() { return name; } @@ -78,6 +92,9 @@ public class BulletinQueryDTO { /** * @return Include bulletins that match this id. Supports a source id */ + @ApiModelProperty( + value = "Will include bulletins from components that match this id. Supports a regular expression." + ) public String getSourceId() { return sourceId; } @@ -89,6 +106,9 @@ public class BulletinQueryDTO { /** * @return The maximum number of bulletins to return */ + @ApiModelProperty( + value = "The maximum number of bulletins to return." + ) public Integer getLimit() { return limit; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/5984b952/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ClusterDTO.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/ClusterDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ClusterDTO.java index 161e788..66e19d7 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ClusterDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ClusterDTO.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.Date; @@ -35,6 +36,9 @@ public class ClusterDTO { /** * @return collection of the node DTOs */ + @ApiModelProperty( + value = "The collection of nodes that are part of the cluster." + ) public Collection<NodeDTO> getNodes() { return nodes; } @@ -47,6 +51,9 @@ public class ClusterDTO { * @return the date/time that this report was generated */ @XmlJavaTypeAdapter(TimeAdapter.class) + @ApiModelProperty( + value = "The timestamp the report was generated." + ) public Date getGenerated() { return generated; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/5984b952/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ComponentHistoryDTO.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/ComponentHistoryDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ComponentHistoryDTO.java index 2345b08..7cf4f73 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ComponentHistoryDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ComponentHistoryDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.Map; import javax.xml.bind.annotation.XmlType; @@ -31,6 +32,9 @@ public class ComponentHistoryDTO { /** * @return component id */ + @ApiModelProperty( + value = "The component id." + ) public String getComponentId() { return componentId; } @@ -42,6 +46,9 @@ public class ComponentHistoryDTO { /** * @return history for this components properties */ + @ApiModelProperty( + value = "The history for the properties of the component." + ) public Map<String, PropertyHistoryDTO> getPropertyHistory() { return propertyHistory; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/5984b952/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ConnectableDTO.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/ConnectableDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ConnectableDTO.java index 7432a72..22c167f 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ConnectableDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ConnectableDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto; +import com.wordnik.swagger.annotations.ApiModelProperty; import javax.xml.bind.annotation.XmlType; /** @@ -36,6 +37,10 @@ public class ConnectableDTO { /** * @return id of this connectable component */ + @ApiModelProperty( + value = "The id of the connectable component.", + required = true + ) public String getId() { return id; } @@ -47,6 +52,11 @@ public class ConnectableDTO { /** * @return type of this connectable component */ + @ApiModelProperty( + value = "The type of component the connectable is.", + required = true, + allowableValues = "PROCESSOR, REMOTE_INPUT_PORT, REMOTE_OUTPUT_PORT, INPUT_PORT, OUTPUT_PORT, FUNNEL" + ) public String getType() { return type; } @@ -58,6 +68,10 @@ public class ConnectableDTO { /** * @return id of the group that this connectable component resides in */ + @ApiModelProperty( + value = "The id of the group that the connectable component resides in", + required = true + ) public String getGroupId() { return groupId; } @@ -69,6 +83,9 @@ public class ConnectableDTO { /** * @return name of this connectable component */ + @ApiModelProperty( + value = "The name of the connectable component" + ) public String getName() { return name; } @@ -80,6 +97,9 @@ public class ConnectableDTO { /** * @return Used to reflect the current state of this Connectable */ + @ApiModelProperty( + value = "Reflects the current state of the connectable component." + ) public Boolean isRunning() { return running; } @@ -91,6 +111,9 @@ public class ConnectableDTO { /** * @return If this represents a remote port it is used to indicate whether the target exists */ + @ApiModelProperty( + value = "If the connectable component represents a remote port, indicates if the target exists." + ) public Boolean getExists() { return exists; } @@ -102,6 +125,9 @@ public class ConnectableDTO { /** * @return If this represents a remote port it is used to indicate whether is it configured to transmit */ + @ApiModelProperty( + value = "If the connectable component represents a remote port, indicates if the target is configured to transmit." + ) public Boolean getTransmitting() { return transmitting; } @@ -113,6 +139,9 @@ public class ConnectableDTO { /** * @return The comments from this Connectable */ + @ApiModelProperty( + value = "The comments for the connectable component." + ) public String getComments() { return comments; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/5984b952/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ConnectionDTO.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/ConnectionDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ConnectionDTO.java index 432f80a..96da9e3 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ConnectionDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ConnectionDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.List; import java.util.Set; import javax.xml.bind.annotation.XmlType; @@ -41,10 +42,13 @@ public class ConnectionDTO extends NiFiComponentDTO { private List<PositionDTO> bends; /** - * The id of the source processor. + * The source of this connection. * - * @return The id of the source processor + * @return The source of this connection */ + @ApiModelProperty( + value = "The source of the connection." + ) public ConnectableDTO getSource() { return source; } @@ -54,10 +58,13 @@ public class ConnectionDTO extends NiFiComponentDTO { } /** - * The id of the target processor. + * The destination of this connection. * - * @return The id of the target processor + * @return The destination of this connection */ + @ApiModelProperty( + value = "The destination of the connection." + ) public ConnectableDTO getDestination() { return destination; } @@ -69,6 +76,9 @@ public class ConnectionDTO extends NiFiComponentDTO { /** * @return name of the connection */ + @ApiModelProperty( + value = "The name of the connection." + ) public String getName() { return name; } @@ -80,6 +90,9 @@ public class ConnectionDTO extends NiFiComponentDTO { /** * @return position of the bend points on this connection */ + @ApiModelProperty( + value = "The bend points on the connection." + ) public List<PositionDTO> getBends() { return bends; } @@ -91,6 +104,9 @@ public class ConnectionDTO extends NiFiComponentDTO { /** * @return The index of control point that the connection label should be placed over */ + @ApiModelProperty( + value = "The index of the bend point where to place the connection label." + ) public Integer getLabelIndex() { return labelIndex; } @@ -102,6 +118,9 @@ public class ConnectionDTO extends NiFiComponentDTO { /** * @return z index for this connection */ + @ApiModelProperty( + value = "The z index of the connection." + ) public Long getzIndex() { return zIndex; } @@ -115,6 +134,9 @@ public class ConnectionDTO extends NiFiComponentDTO { * * @return The relationships */ + @ApiModelProperty( + value = "The selected relationship that comprise the connection." + ) public Set<String> getSelectedRelationships() { return selectedRelationships; } @@ -126,6 +148,10 @@ public class ConnectionDTO extends NiFiComponentDTO { /** * @return relationships that the source of the connection currently supports. This property is read only */ + @ApiModelProperty( + value = "The relationships that the source of the connection currently supports. This property is read only.", + readOnly = true + ) public Set<String> getAvailableRelationships() { return availableRelationships; } @@ -140,6 +166,10 @@ public class ConnectionDTO extends NiFiComponentDTO { * * @return The back pressure object threshold */ + @ApiModelProperty( + value = "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files " + + "over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." + ) public Long getBackPressureObjectThreshold() { return backPressureObjectThreshold; } @@ -154,6 +184,10 @@ public class ConnectionDTO extends NiFiComponentDTO { * * @return The back pressure data size threshold */ + @ApiModelProperty( + value = "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing " + + "files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." + ) public String getBackPressureDataSizeThreshold() { return backPressureDataSizeThreshold; } @@ -168,6 +202,10 @@ public class ConnectionDTO extends NiFiComponentDTO { * * @return The flow file expiration in minutes */ + @ApiModelProperty( + value = "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from " + + "the flow the next time a processor attempts to start work on it." + ) public String getFlowFileExpiration() { return flowFileExpiration; } @@ -177,10 +215,13 @@ public class ConnectionDTO extends NiFiComponentDTO { } /** - * The prioritizers this processor is using. + * The prioritizers this connection is using. * * @return The prioritizer list */ + @ApiModelProperty( + value = "The comparators used to prioritize the queue." + ) public List<String> getPrioritizers() { return prioritizers; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/5984b952/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerConfigurationDTO.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/ControllerConfigurationDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerConfigurationDTO.java index c6f36f3..9f92598 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerConfigurationDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerConfigurationDTO.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; @@ -44,6 +45,9 @@ public class ControllerConfigurationDTO { /** * @return maximum number of timer driven threads this NiFi has available */ + @ApiModelProperty( + value = "The maimum number of timer driven threads the NiFi has available." + ) public Integer getMaxTimerDrivenThreadCount() { return maxTimerDrivenThreadCount; } @@ -55,6 +59,9 @@ public class ControllerConfigurationDTO { /** * @return maximum number of event driven thread this NiFi has available */ + @ApiModelProperty( + value = "The maximum number of event driven threads the NiFi has avaiable." + ) public Integer getMaxEventDrivenThreadCount() { return maxEventDrivenThreadCount; } @@ -66,6 +73,9 @@ public class ControllerConfigurationDTO { /** * @return name of this NiFi */ + @ApiModelProperty( + value = "The name of this NiFi." + ) public String getName() { return name; } @@ -77,6 +87,9 @@ public class ControllerConfigurationDTO { /** * @return comments for this NiFi */ + @ApiModelProperty( + value = "The comments for this NiFi." + ) public String getComments() { return comments; } @@ -88,6 +101,10 @@ public class ControllerConfigurationDTO { /** * @return interval in seconds between the automatic NiFi refresh requests. This value is read only */ + @ApiModelProperty( + value = "The interval in seconds between the automatic NiFi refresh requests.", + readOnly = true + ) public Long getAutoRefreshIntervalSeconds() { return autoRefreshIntervalSeconds; } @@ -99,6 +116,10 @@ public class ControllerConfigurationDTO { /** * @return Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication). This value is read only */ + @ApiModelProperty( + value = "Indicates whether site to site communication with the NiFi is secure (requires 2-way authenticiation).", + readOnly = true + ) public Boolean isSiteToSiteSecure() { return siteToSiteSecure; } @@ -111,6 +132,9 @@ public class ControllerConfigurationDTO { * @return current time on the server */ @XmlJavaTypeAdapter(TimeAdapter.class) + @ApiModelProperty( + value = "The current time on the system." + ) public Date getCurrentTime() { return currentTime; } @@ -122,6 +146,9 @@ public class ControllerConfigurationDTO { /** * @return time offset of the server */ + @ApiModelProperty( + value = "The time offset of the system." + ) public Integer getTimeOffset() { return timeOffset; } @@ -133,6 +160,9 @@ public class ControllerConfigurationDTO { /** * @return the URL for the content viewer if configured */ + @ApiModelProperty( + value = "The URL for the content viewer if configured." + ) public String getContentViewerUrl() { return contentViewerUrl; } @@ -144,6 +174,9 @@ public class ControllerConfigurationDTO { /** * @return URI for this NiFi controller */ + @ApiModelProperty( + value = "The URI for the NiFi." + ) public String getUri() { return uri; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/5984b952/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerDTO.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/ControllerDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerDTO.java index 34008e0..a47adcf 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerDTO.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; @@ -48,6 +49,9 @@ public class ControllerDTO { /** * @return id of this NiFi controller */ + @ApiModelProperty( + value = "The id of the NiFi." + ) public String getId() { return id; } @@ -61,6 +65,9 @@ public class ControllerDTO { * * @return The name of this controller */ + @ApiModelProperty( + value = "The name of the NiFi." + ) public String getName() { return name; } @@ -72,6 +79,9 @@ public class ControllerDTO { /** * @return comments of this NiFi controller */ + @ApiModelProperty( + value = "The comments for the NiFi." + ) public String getComments() { return comments; } @@ -83,6 +93,9 @@ public class ControllerDTO { /** * @return input ports available to send data to this NiFi controller */ + @ApiModelProperty( + value = "The input ports available to send data to for the NiFi." + ) public Set<PortDTO> getInputPorts() { return inputPorts; } @@ -94,6 +107,9 @@ public class ControllerDTO { /** * @return output ports available to received data from this NiFi controller */ + @ApiModelProperty( + value = "The output ports available to received data from the NiFi." + ) public Set<PortDTO> getOutputPorts() { return outputPorts; } @@ -105,6 +121,9 @@ public class ControllerDTO { /** * @return Instance ID of the cluster, if this node is connected to a Cluster Manager, or of this individual instance of in standalone mode */ + @ApiModelProperty( + value = "If clustered, the id of the Cluster Manager, otherwise the id of the NiFi." + ) public String getInstanceId() { return instanceId; } @@ -118,6 +137,10 @@ public class ControllerDTO { * * @return a integer between 1 and 65535, or null, if not configured for remote transfer */ + @ApiModelProperty( + value = "The Socket Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote " + + "instances, this will be null." + ) public Integer getRemoteSiteListeningPort() { return remoteSiteListeningPort; } @@ -129,6 +152,9 @@ public class ControllerDTO { /** * @return Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication) */ + @ApiModelProperty( + value = "Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication)." + ) public Boolean isSiteToSiteSecure() { return siteToSiteSecure; } @@ -140,6 +166,9 @@ public class ControllerDTO { /** * @return number of running components in this process group */ + @ApiModelProperty( + value = "The number of running components in the NiFi." + ) public Integer getRunningCount() { return runningCount; } @@ -151,6 +180,9 @@ public class ControllerDTO { /** * @return number of stopped components in this process group */ + @ApiModelProperty( + value = "The number of stopped components in the NiFi." + ) public Integer getStoppedCount() { return stoppedCount; } @@ -162,6 +194,9 @@ public class ControllerDTO { /** * @return number of active remote ports contained in this process group */ + @ApiModelProperty( + value = "The number of active remote ports contained in the NiFi." + ) public Integer getActiveRemotePortCount() { return activeRemotePortCount; } @@ -173,6 +208,9 @@ public class ControllerDTO { /** * @return number of inactive remote ports contained in this process group */ + @ApiModelProperty( + value = "The number of inactive remote porst contained in the NiFi." + ) public Integer getInactiveRemotePortCount() { return inactiveRemotePortCount; } @@ -184,6 +222,9 @@ public class ControllerDTO { /** * @return number of input ports contained in this process group */ + @ApiModelProperty( + value = "The number of input ports contained in the NiFi." + ) public Integer getInputPortCount() { return inputPortCount; } @@ -195,6 +236,9 @@ public class ControllerDTO { /** * @return number of invalid components in this process group */ + @ApiModelProperty( + value = "The number of invalid components in the NiFi." + ) public Integer getInvalidCount() { return invalidCount; } @@ -206,6 +250,9 @@ public class ControllerDTO { /** * @return number of disabled components in this process group */ + @ApiModelProperty( + value = "The number of disabled components in the NiFi." + ) public Integer getDisabledCount() { return disabledCount; } @@ -217,6 +264,9 @@ public class ControllerDTO { /** * @return number of output ports in this process group */ + @ApiModelProperty( + value = "The number of output ports in the NiFi." + ) public Integer getOutputPortCount() { return outputPortCount; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/5984b952/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerServiceDTO.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/ControllerServiceDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerServiceDTO.java index 8394705..3abd7f2 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerServiceDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerServiceDTO.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; import java.util.Set; @@ -46,6 +47,9 @@ public class ControllerServiceDTO extends NiFiComponentDTO { /** * @return controller service name */ + @ApiModelProperty( + value = "The name of the controller service." + ) public String getName() { return name; } @@ -57,6 +61,9 @@ public class ControllerServiceDTO extends NiFiComponentDTO { /** * @return the controller service type */ + @ApiModelProperty( + value = "The type of the controller service." + ) public String getType() { return type; } @@ -68,6 +75,9 @@ public class ControllerServiceDTO extends NiFiComponentDTO { /** * @return the comment for the Controller Service */ + @ApiModelProperty( + value = "The comments for the controller service." + ) public String getComments() { return comments; } @@ -79,6 +89,10 @@ public class ControllerServiceDTO extends NiFiComponentDTO { /** * @return Where this service is available. Possible values are NCM, NODE */ + @ApiModelProperty( + value = "Where the servcie is available.", + allowableValues = "NCM, NODE" + ) public String getAvailability() { return availability; } @@ -90,6 +104,10 @@ public class ControllerServiceDTO extends NiFiComponentDTO { /** * @return The state of this controller service. Possible values are ENABLED, ENABLING, DISABLED, DISABLING */ + @ApiModelProperty( + value = "The state of the controller service.", + allowableValues = "ENABLED, ENABLING, DISABLED, DISABLING" + ) public String getState() { return state; } @@ -101,6 +119,9 @@ public class ControllerServiceDTO extends NiFiComponentDTO { /** * @return controller service properties */ + @ApiModelProperty( + value = "The properties of the controller service." + ) public Map<String, String> getProperties() { return properties; } @@ -112,6 +133,9 @@ public class ControllerServiceDTO extends NiFiComponentDTO { /** * @return descriptors for the controller service properties */ + @ApiModelProperty( + value = "The descriptors for the controller service properties." + ) public Map<String, PropertyDescriptorDTO> getDescriptors() { return descriptors; } @@ -123,6 +147,9 @@ public class ControllerServiceDTO extends NiFiComponentDTO { /** * @return the URL for this controller services custom configuration UI if applicable. Null otherwise */ + @ApiModelProperty( + value = "The URL for the controller services custom configuration UI if applicable." + ) public String getCustomUiUrl() { return customUiUrl; } @@ -134,6 +161,9 @@ public class ControllerServiceDTO extends NiFiComponentDTO { /** * @return annotation data for this controller service */ + @ApiModelProperty( + value = "The annontation for the controller service. This is how the custom UI relays configuration to the controller service." + ) public String getAnnotationData() { return annotationData; } @@ -145,6 +175,9 @@ public class ControllerServiceDTO extends NiFiComponentDTO { /** * @return all components referencing this controller service */ + @ApiModelProperty( + value = "All components referencing this controller service." + ) public Set<ControllerServiceReferencingComponentDTO> getReferencingComponents() { return referencingComponents; } @@ -158,6 +191,9 @@ public class ControllerServiceDTO extends NiFiComponentDTO { * * @return The validation errors */ + @ApiModelProperty( + value = "The validation errors from the controller service. These validation errors represent the problems with the controller service that must be resolved before it can be enabled." + ) public Collection<String> getValidationErrors() { return validationErrors; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/5984b952/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerServiceReferencingComponentDTO.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/ControllerServiceReferencingComponentDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerServiceReferencingComponentDTO.java index f927122..f4290ff 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerServiceReferencingComponentDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerServiceReferencingComponentDTO.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; import java.util.Set; @@ -47,6 +48,10 @@ public class ControllerServiceReferencingComponentDTO { /** * @return Group id for this component referencing a controller service. If this component is another service, this field is blank */ + @ApiModelProperty( + value = "The group id for the component referencing a controller service. If this component is another controller service or a reporting " + + "task, this field is blank." + ) public String getGroupId() { return groupId; } @@ -58,6 +63,9 @@ public class ControllerServiceReferencingComponentDTO { /** * @return id for this component referencing a controller service */ + @ApiModelProperty( + value = "The id of the component referencing a controller service." + ) public String getId() { return id; } @@ -69,6 +77,9 @@ public class ControllerServiceReferencingComponentDTO { /** * @return name for this component referencing a controller service */ + @ApiModelProperty( + value = "The name of the component referencing a controller service." + ) public String getName() { return name; } @@ -80,6 +91,9 @@ public class ControllerServiceReferencingComponentDTO { /** * @return type for this component referencing a controller service */ + @ApiModelProperty( + value = "The type of the component referencing a controller service." + ) public String getType() { return type; } @@ -91,6 +105,10 @@ public class ControllerServiceReferencingComponentDTO { /** * @return state of the processor referencing a controller service. If this component is another service, this field is blank */ + @ApiModelProperty( + value = "The state of a processor or reporting task referencing a controller service. If this component is another controller " + + "service, this field is blank." + ) public String getState() { return state; } @@ -102,6 +120,10 @@ public class ControllerServiceReferencingComponentDTO { /** * @return type of reference this is (Processor, ControllerService, or ReportingTask) */ + @ApiModelProperty( + value = "The type of reference this is.", + allowableValues = "Processor, ControllerService, or ReportingTask" + ) public String getReferenceType() { return referenceType; } @@ -113,6 +135,9 @@ public class ControllerServiceReferencingComponentDTO { /** * @return component properties */ + @ApiModelProperty( + value = "The properties for the component." + ) public Map<String, String> getProperties() { return properties; } @@ -124,6 +149,9 @@ public class ControllerServiceReferencingComponentDTO { /** * @return descriptors for the components properties */ + @ApiModelProperty( + value = "The descriptors for the componet properties." + ) public Map<String, PropertyDescriptorDTO> getDescriptors() { return descriptors; } @@ -135,6 +163,9 @@ public class ControllerServiceReferencingComponentDTO { /** * @return Any validation error associated with this component */ + @ApiModelProperty( + value = "The validation errors for the component." + ) public Collection<String> getValidationErrors() { return validationErrors; } @@ -146,6 +177,9 @@ public class ControllerServiceReferencingComponentDTO { /** * @return active thread count for the referencing component */ + @ApiModelProperty( + value = "The number of active threads for the referencing component." + ) public Integer getActiveThreadCount() { return activeThreadCount; } @@ -157,6 +191,9 @@ public class ControllerServiceReferencingComponentDTO { /** * @return If this referencing component represents a ControllerService, these are the components that reference it */ + @ApiModelProperty( + value = "If the referencing component represents a controller service, these are the components that referenc it." + ) public Set<ControllerServiceReferencingComponentDTO> getReferencingComponents() { return referencingComponents; } @@ -168,6 +205,9 @@ public class ControllerServiceReferencingComponentDTO { /** * @return If this referencing component represents a ControllerService, this indicates whether it has already been represented in this hierarchy */ + @ApiModelProperty( + value = "If the referencing component represents a controller service, this indicates whether it has already been represented in this hierarchy." + ) public Boolean getReferenceCycle() { return referenceCycle; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/5984b952/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/CounterDTO.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/CounterDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/CounterDTO.java index 7f47bf5..615ad93 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/CounterDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/CounterDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto; +import com.wordnik.swagger.annotations.ApiModelProperty; import javax.xml.bind.annotation.XmlType; /** @@ -33,6 +34,9 @@ public class CounterDTO { /** * @return context of the counter */ + @ApiModelProperty( + value = "The context of the counter." + ) public String getContext() { return context; } @@ -44,6 +48,9 @@ public class CounterDTO { /** * @return id of the counter */ + @ApiModelProperty( + value = "The id of the counter." + ) public String getId() { return id; } @@ -55,6 +62,9 @@ public class CounterDTO { /** * @return name of the counter */ + @ApiModelProperty( + value = "The name of the counter." + ) public String getName() { return name; } @@ -66,6 +76,9 @@ public class CounterDTO { /** * @return value for the counter */ + @ApiModelProperty( + value = "The value of the counter." + ) public String getValue() { return value; } @@ -74,6 +87,9 @@ public class CounterDTO { this.value = value; } + @ApiModelProperty( + value = "The value count." + ) public Long getValueCount() { return valueCount; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/5984b952/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/CountersDTO.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/CountersDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/CountersDTO.java index d9f45e3..0f162c9 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/CountersDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/CountersDTO.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.Date; @@ -35,6 +36,9 @@ public class CountersDTO { /** * @return the collection of counters */ + @ApiModelProperty( + value = "All counters in the NiFi." + ) public Collection<CounterDTO> getCounters() { return counters; } @@ -47,6 +51,9 @@ public class CountersDTO { * @return the date/time that this report was generated */ @XmlJavaTypeAdapter(TimeAdapter.class) + @ApiModelProperty( + value = "The timestamp when the report was generated." + ) public Date getGenerated() { return generated; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/5984b952/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/DocumentedTypeDTO.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/DocumentedTypeDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/DocumentedTypeDTO.java index 2241d62..f82ff6c 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/DocumentedTypeDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/DocumentedTypeDTO.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; @@ -32,6 +33,9 @@ public class DocumentedTypeDTO { /** * @return An optional description of the corresponding type */ + @ApiModelProperty( + value = "The description of the type." + ) public String getDescription() { return description; } @@ -43,6 +47,9 @@ public class DocumentedTypeDTO { /** * @return The type is the fully-qualified name of a Java class */ + @ApiModelProperty( + value = "The fulley qualified name of the type." + ) public String getType() { return type; } @@ -54,6 +61,9 @@ public class DocumentedTypeDTO { /** * @return The tags associated with this type */ + @ApiModelProperty( + value = "The tags associated with this type." + ) public Set<String> getTags() { return tags; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/5984b952/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/FlowSnippetDTO.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/FlowSnippetDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/FlowSnippetDTO.java index 5aec78f..1ce390e 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/FlowSnippetDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/FlowSnippetDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.LinkedHashSet; import java.util.Set; import javax.xml.bind.annotation.XmlType; @@ -39,6 +40,9 @@ public class FlowSnippetDTO { /** * @return connections in this flow snippet */ + @ApiModelProperty( + value = "The connections in this flow snippet." + ) public Set<ConnectionDTO> getConnections() { return connections; } @@ -50,6 +54,9 @@ public class FlowSnippetDTO { /** * @return input ports in this flow snippet */ + @ApiModelProperty( + value = "The input ports in this flow snippet." + ) public Set<PortDTO> getInputPorts() { return inputPorts; } @@ -61,6 +68,9 @@ public class FlowSnippetDTO { /** * @return labels in this flow snippet */ + @ApiModelProperty( + value = "The labels in this flow snippet." + ) public Set<LabelDTO> getLabels() { return labels; } @@ -72,6 +82,9 @@ public class FlowSnippetDTO { /** * @return funnels in this flow snippet */ + @ApiModelProperty( + value = "The funnels in this flow snippet." + ) public Set<FunnelDTO> getFunnels() { return funnels; } @@ -83,6 +96,9 @@ public class FlowSnippetDTO { /** * @return output ports in this flow snippet */ + @ApiModelProperty( + value = "The output ports in this flow snippet." + ) public Set<PortDTO> getOutputPorts() { return outputPorts; } @@ -94,6 +110,9 @@ public class FlowSnippetDTO { /** * @return process groups in this flow snippet */ + @ApiModelProperty( + value = "The process groups in this flow snippet." + ) public Set<ProcessGroupDTO> getProcessGroups() { return processGroups; } @@ -105,6 +124,9 @@ public class FlowSnippetDTO { /** * @return processors in this flow group */ + @ApiModelProperty( + value = "The processors in this flow snippet." + ) public Set<ProcessorDTO> getProcessors() { return processors; } @@ -116,6 +138,9 @@ public class FlowSnippetDTO { /** * @return remote process groups in this flow snippet */ + @ApiModelProperty( + value = "The remote process groups in this flow snippet." + ) public Set<RemoteProcessGroupDTO> getRemoteProcessGroups() { return remoteProcessGroups; } @@ -127,6 +152,9 @@ public class FlowSnippetDTO { /** * @return the Controller Services in this flow snippet */ + @ApiModelProperty( + value = "The controller services in this flow snippet." + ) public Set<ControllerServiceDTO> getControllerServices() { return controllerServices; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/5984b952/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/LabelDTO.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/LabelDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/LabelDTO.java index d15ceb4..e9016db 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/LabelDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/LabelDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.Map; import javax.xml.bind.annotation.XmlType; @@ -32,7 +33,7 @@ public class LabelDTO extends NiFiComponentDTO { private Double height; // font-size = 12px - // color = #eee + // background-color = #eee private Map<String, String> style; public LabelDTO() { @@ -43,6 +44,9 @@ public class LabelDTO extends NiFiComponentDTO { * * @return The label text */ + @ApiModelProperty( + value = "The text that appears in the label." + ) public String getLabel() { return label; } @@ -54,6 +58,9 @@ public class LabelDTO extends NiFiComponentDTO { /** * @return style for this label */ + @ApiModelProperty( + value = "The styles for this label (font-size => 12px, background-color => #eee, etc)." + ) public Map<String, String> getStyle() { return style; } @@ -65,6 +72,9 @@ public class LabelDTO extends NiFiComponentDTO { /** * @return height of the label in pixels when at a 1:1 scale */ + @ApiModelProperty( + value = "The height of the label in pixels when at a 1:1 scale." + ) public Double getHeight() { return height; } @@ -76,6 +86,9 @@ public class LabelDTO extends NiFiComponentDTO { /** * @return width of the label in pixels when at a 1:1 scale */ + @ApiModelProperty( + value = "The width of the label in pixels when at a 1:1 scale." + ) public Double getWidth() { return width; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/5984b952/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NiFiComponentDTO.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/NiFiComponentDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NiFiComponentDTO.java index 074a2e3..e89fb5d 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NiFiComponentDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NiFiComponentDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto; +import com.wordnik.swagger.annotations.ApiModelProperty; import javax.xml.bind.annotation.XmlType; /** @@ -46,6 +47,9 @@ public class NiFiComponentDTO { * * @return The id */ + @ApiModelProperty( + value = "The id of the component." + ) public String getId() { return this.id; } @@ -57,6 +61,9 @@ public class NiFiComponentDTO { /** * @return id for the parent group of this component if applicable, null otherwise */ + @ApiModelProperty( + value = "The id of parent process group of this component if applicable." + ) public String getParentGroupId() { return parentGroupId; } @@ -70,6 +77,9 @@ public class NiFiComponentDTO { * * @return The uri */ + @ApiModelProperty( + value = "The URI for futures requests to the component." + ) public String getUri() { return uri; } @@ -87,6 +97,9 @@ public class NiFiComponentDTO { * * @return The position */ + @ApiModelProperty( + value = "The position of this component in the UI if applicable." + ) public PositionDTO getPosition() { return position; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/5984b952/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NodeDTO.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/NodeDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NodeDTO.java index 6aae62f..f0aa9c4 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NodeDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NodeDTO.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; @@ -44,6 +45,9 @@ public class NodeDTO { * @return node's last heartbeat timestamp */ @XmlJavaTypeAdapter(DateTimeAdapter.class) + @ApiModelProperty( + value = "the time of the nodes's last heartbeat." + ) public Date getHeartbeat() { return heartbeat; } @@ -56,6 +60,9 @@ public class NodeDTO { * @return time of the node's last connection request */ @XmlJavaTypeAdapter(DateTimeAdapter.class) + @ApiModelProperty( + value = "The time of the node's last connection request." + ) public Date getConnectionRequested() { return connectionRequested; } @@ -69,6 +76,9 @@ public class NodeDTO { * * @return The active thread count */ + @ApiModelProperty( + value = "The active threads for the NiFi on the node." + ) public Integer getActiveThreadCount() { return activeThreadCount; } @@ -80,6 +90,9 @@ public class NodeDTO { /** * @return queue for the controller */ + @ApiModelProperty( + value = "The queue the NiFi on the node." + ) public String getQueued() { return queued; } @@ -91,6 +104,9 @@ public class NodeDTO { /** * @return node's host/IP address */ + @ApiModelProperty( + value = "The node's host/ip address." + ) public String getAddress() { return address; } @@ -102,6 +118,9 @@ public class NodeDTO { /** * @return node ID */ + @ApiModelProperty( + value = "The id of the node." + ) public String getNodeId() { return nodeId; } @@ -113,6 +132,9 @@ public class NodeDTO { /** * @return port the node is listening for API requests */ + @ApiModelProperty( + value = "The port the node is listening for API requests." + ) public Integer getApiPort() { return apiPort; } @@ -124,6 +146,9 @@ public class NodeDTO { /** * @return node's status */ + @ApiModelProperty( + value = "The node's status." + ) public String getStatus() { return status; } @@ -135,6 +160,9 @@ public class NodeDTO { /** * @return node's events */ + @ApiModelProperty( + value = "The node's events." + ) public List<NodeEventDTO> getEvents() { return events; } @@ -146,6 +174,9 @@ public class NodeDTO { /** * @return whether this node is the primary node within the cluster */ + @ApiModelProperty( + value = "Whether the node is the primary node within the cluster." + ) public Boolean isPrimary() { return primary; } @@ -158,6 +189,9 @@ public class NodeDTO { * @return time at which this Node was last restarted */ @XmlJavaTypeAdapter(DateTimeAdapter.class) + @ApiModelProperty( + value = "The time at which this Node was last refreshed." + ) public Date getNodeStartTime() { return nodeStartTime; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/5984b952/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NodeEventDTO.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/NodeEventDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NodeEventDTO.java index 7d8273f..f0b61a7 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NodeEventDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NodeEventDTO.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 NodeEventDTO { /** * @return category of the node event */ + @ApiModelProperty( + value = "The category of the node event." + ) public String getCategory() { return category; } @@ -45,6 +49,9 @@ public class NodeEventDTO { /** * @return message of the node event */ + @ApiModelProperty( + value = "The message in the node event." + ) public String getMessage() { return message; } @@ -57,6 +64,9 @@ public class NodeEventDTO { * @return timestamp of the node event */ @XmlJavaTypeAdapter(DateTimeAdapter.class) + @ApiModelProperty( + value = "The timestamp of the node event." + ) public Date getTimestamp() { return timestamp; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/5984b952/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NodeSystemDiagnosticsDTO.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/NodeSystemDiagnosticsDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NodeSystemDiagnosticsDTO.java index f7aff79..8f925aa 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NodeSystemDiagnosticsDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NodeSystemDiagnosticsDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto; +import com.wordnik.swagger.annotations.ApiModelProperty; import javax.xml.bind.annotation.XmlType; /** @@ -30,6 +31,9 @@ public class NodeSystemDiagnosticsDTO { /** * @return the node */ + @ApiModelProperty( + value = "The node." + ) public NodeDTO getNode() { return node; } @@ -41,6 +45,9 @@ public class NodeSystemDiagnosticsDTO { /** * @return the system diagnostics */ + @ApiModelProperty( + value = "The diagnostics for the system the node is on." + ) public SystemDiagnosticsDTO getSystemDiagnostics() { return systemDiagnostics; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/5984b952/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PortDTO.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/PortDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PortDTO.java index 6a90723..489ed0c 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PortDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PortDTO.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.Set; import javax.xml.bind.annotation.XmlType; @@ -40,6 +41,9 @@ public class PortDTO extends NiFiComponentDTO { /** * @return name of this port */ + @ApiModelProperty( + value = "The name of the port." + ) public String getName() { return name; } @@ -51,6 +55,10 @@ public class PortDTO extends NiFiComponentDTO { /** * @return The state of this port. Possible states are 'RUNNING', 'STOPPED', and 'DISABLED' */ + @ApiModelProperty( + value = "The state of the port.", + allowableValues = "RUNNING, STOPPED, DISABLED" + ) public String getState() { return state; } @@ -64,6 +72,10 @@ public class PortDTO extends NiFiComponentDTO { * * @return The type of port */ + @ApiModelProperty( + value = "The type of port.", + allowableValues = "INPUT_PORT, OUTPUT_PORT" + ) public String getType() { return type; } @@ -75,6 +87,9 @@ public class PortDTO extends NiFiComponentDTO { /** * @return number of tasks that should be concurrently scheduled for this port */ + @ApiModelProperty( + value = "The number of tasks that should be concurrently scheduled for the port." + ) public Integer getConcurrentlySchedulableTaskCount() { return concurrentlySchedulableTaskCount; } @@ -86,6 +101,9 @@ public class PortDTO extends NiFiComponentDTO { /** * @return comments for this port */ + @ApiModelProperty( + value = "The comments for the port." + ) public String getComments() { return comments; } @@ -97,6 +115,9 @@ public class PortDTO extends NiFiComponentDTO { /** * @return whether this port has incoming or outgoing connections to a remote NiFi. This is only applicable when the port is running on the root group */ + @ApiModelProperty( + value = "Whether the port has incoming or output connections to a remote NiFi. This is only applicable when the port is running in the root group." + ) public Boolean isTransmitting() { return transmitting; } @@ -108,6 +129,9 @@ public class PortDTO extends NiFiComponentDTO { /** * @return groups that are allowed to access this port */ + @ApiModelProperty( + value = "The user groups that are allowed to access the port." + ) public Set<String> getGroupAccessControl() { return groupAccessControl; } @@ -119,6 +143,9 @@ public class PortDTO extends NiFiComponentDTO { /** * @return users that are allowed to access this port */ + @ApiModelProperty( + value = "The users that are allowed to access the port." + ) public Set<String> getUserAccessControl() { return userAccessControl; } @@ -132,6 +159,9 @@ public class PortDTO extends NiFiComponentDTO { * * @return The validation errors */ + @ApiModelProperty( + value = "Gets the validation errors from this port. These validation errors represent the problems with the port that must be resolved before it can be started." + ) public Collection<String> getValidationErrors() { return validationErrors; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/5984b952/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PositionDTO.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/PositionDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PositionDTO.java index 5b0f386..ef42387 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PositionDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PositionDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto; +import com.wordnik.swagger.annotations.ApiModelProperty; import javax.xml.bind.annotation.XmlType; /** @@ -39,6 +40,9 @@ public class PositionDTO { /** * @return the x coordinate */ + @ApiModelProperty( + value = "The x coordinate." + ) public Double getX() { return x; } @@ -50,6 +54,9 @@ public class PositionDTO { /** * @return the y coordinate */ + @ApiModelProperty( + value = "The y coordinate." + ) public Double getY() { return y; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/5984b952/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/5984b952/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; }
