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/RemoteProcessGroupDetailsDTO.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/RemoteProcessGroupDetailsDTO.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/RemoteProcessGroupDetailsDTO.java index a696a25..0d0bc06 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/RemoteProcessGroupDetailsDTO.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/RemoteProcessGroupDetailsDTO.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 RemoteProcessGroupDetailsDTO extends ComponentDetailsDTO { /** * @return URI of the remote process group */ + @ApiModelProperty( + value = "The uri of the target of the remote process group." + ) public String getUri() { return uri; }
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/details/ConfigureDetailsDTO.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/details/ConfigureDetailsDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/details/ConfigureDetailsDTO.java index 2239946..7b79bd0 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/details/ConfigureDetailsDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/details/ConfigureDetailsDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.action.details; +import com.wordnik.swagger.annotations.ApiModelProperty; import javax.xml.bind.annotation.XmlType; /** @@ -31,6 +32,9 @@ public class ConfigureDetailsDTO extends ActionDetailsDTO { /** * @return name of the property that was modified */ + @ApiModelProperty( + value = "The name of the property that was modified." + ) public String getName() { return name; } @@ -42,6 +46,9 @@ public class ConfigureDetailsDTO extends ActionDetailsDTO { /** * @return previous value */ + @ApiModelProperty( + value = "The previous value." + ) public String getPreviousValue() { return previousValue; } @@ -53,6 +60,9 @@ public class ConfigureDetailsDTO extends ActionDetailsDTO { /** * @return new value */ + @ApiModelProperty( + value = "The new value." + ) public String getValue() { return value; } 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/details/ConnectDetailsDTO.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/details/ConnectDetailsDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/details/ConnectDetailsDTO.java index a6d5d99..db2804f 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/details/ConnectDetailsDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/details/ConnectDetailsDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.action.details; +import com.wordnik.swagger.annotations.ApiModelProperty; import javax.xml.bind.annotation.XmlType; /** @@ -35,6 +36,9 @@ public class ConnectDetailsDTO extends ActionDetailsDTO { /** * @return id of the source of the connection */ + @ApiModelProperty( + value = "The id of the source of the connection." + ) public String getSourceId() { return sourceId; } @@ -46,6 +50,9 @@ public class ConnectDetailsDTO extends ActionDetailsDTO { /** * @return name of the source of the connection */ + @ApiModelProperty( + value = "The name of the source of the connection." + ) public String getSourceName() { return sourceName; } @@ -57,6 +64,9 @@ public class ConnectDetailsDTO extends ActionDetailsDTO { /** * @return type of the source of the connection */ + @ApiModelProperty( + value = "The type of the source of the connection." + ) public String getSourceType() { return sourceType; } @@ -68,6 +78,9 @@ public class ConnectDetailsDTO extends ActionDetailsDTO { /** * @return name of the relationship that was connected */ + @ApiModelProperty( + value = "The name of the relationship that was connected." + ) public String getRelationship() { return relationship; } @@ -79,6 +92,9 @@ public class ConnectDetailsDTO extends ActionDetailsDTO { /** * @return id of the destination of the connection */ + @ApiModelProperty( + value = "The id of the destination of the connection." + ) public String getDestinationId() { return destinationId; } @@ -90,6 +106,9 @@ public class ConnectDetailsDTO extends ActionDetailsDTO { /** * @return name of the destination of the connection */ + @ApiModelProperty( + value = "The name of the destination of the connection." + ) public String getDestinationName() { return destinationName; } @@ -101,6 +120,9 @@ public class ConnectDetailsDTO extends ActionDetailsDTO { /** * @return type of the destination of the connection */ + @ApiModelProperty( + value = "The type of the destination of the connection." + ) public String getDestinationType() { return destinationType; } 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/details/MoveDetailsDTO.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/details/MoveDetailsDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/details/MoveDetailsDTO.java index a7f7cf8..f6984a8 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/details/MoveDetailsDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/details/MoveDetailsDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.action.details; +import com.wordnik.swagger.annotations.ApiModelProperty; import javax.xml.bind.annotation.XmlType; /** @@ -32,6 +33,9 @@ public class MoveDetailsDTO extends ActionDetailsDTO { /** * @return id of the group the components previously belonged to */ + @ApiModelProperty( + value = "The id of the group the components previously belonged to." + ) public String getPreviousGroupId() { return previousGroupId; } @@ -43,6 +47,9 @@ public class MoveDetailsDTO extends ActionDetailsDTO { /** * @return name of the group of the components previously belonged to */ + @ApiModelProperty( + value = "The name of the group the components previously belonged to." + ) public String getPreviousGroup() { return previousGroup; } @@ -54,6 +61,9 @@ public class MoveDetailsDTO extends ActionDetailsDTO { /** * @return id of the group the components belong to */ + @ApiModelProperty( + value = "The id of the group that components belong to." + ) public String getGroupId() { return groupId; } @@ -65,6 +75,9 @@ public class MoveDetailsDTO extends ActionDetailsDTO { /** * @return name of the group the components belong to */ + @ApiModelProperty( + value = "The name of the group the components belong to." + ) public String getGroup() { return group; } 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/details/PurgeDetailsDTO.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/details/PurgeDetailsDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/details/PurgeDetailsDTO.java index 6d5b02f..b83e91d 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/details/PurgeDetailsDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/details/PurgeDetailsDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.action.details; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.Date; import javax.xml.bind.annotation.XmlType; import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter; @@ -33,6 +34,9 @@ public class PurgeDetailsDTO extends ActionDetailsDTO { * @return end date for this purge action */ @XmlJavaTypeAdapter(DateTimeAdapter.class) + @ApiModelProperty( + value = "The end date for the purge action." + ) public Date getEndDate() { return endDate; } 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/provenance/AttributeDTO.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/provenance/AttributeDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/AttributeDTO.java index a9db5d0..8228ac3 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/AttributeDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/AttributeDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.provenance; +import com.wordnik.swagger.annotations.ApiModelProperty; import javax.xml.bind.annotation.XmlType; /** @@ -31,6 +32,9 @@ public class AttributeDTO { /** * @return attribute name */ + @ApiModelProperty( + value = "The attribute name." + ) public String getName() { return name; } @@ -42,6 +46,9 @@ public class AttributeDTO { /** * @return attribute value */ + @ApiModelProperty( + value = "The attribute value." + ) public String getValue() { return value; } @@ -53,6 +60,9 @@ public class AttributeDTO { /** * @return value of this attribute before the event took place */ + @ApiModelProperty( + value = "The value of the attribute before the event took place." + ) public String getPreviousValue() { return previousValue; } 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/provenance/ProvenanceDTO.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/provenance/ProvenanceDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/ProvenanceDTO.java index 54a5858..e755581 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/ProvenanceDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/ProvenanceDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.provenance; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.Date; import javax.xml.bind.annotation.XmlType; @@ -45,6 +46,9 @@ public class ProvenanceDTO { /** * @return id of this provenance query */ + @ApiModelProperty( + value = "The id of the provenance query." + ) public String getId() { return id; } @@ -56,6 +60,9 @@ public class ProvenanceDTO { /** * @return URI for this query. Used for obtaining the requests at a later time */ + @ApiModelProperty( + value = "The URI for this query. Used for obtaining/deleting the request at a later time" + ) public String getUri() { return uri; } @@ -67,6 +74,9 @@ public class ProvenanceDTO { /** * @return id of the node in the cluster where this provenance originated */ + @ApiModelProperty( + value = "The id of the node in the cluster where this provenance originated." + ) public String getClusterNodeId() { return clusterNodeId; } @@ -79,6 +89,9 @@ public class ProvenanceDTO { * @return time the query was submitted */ @XmlJavaTypeAdapter(TimestampAdapter.class) + @ApiModelProperty( + value = "The timestamp when the query was submitted." + ) public Date getSubmissionTime() { return submissionTime; } @@ -91,6 +104,9 @@ public class ProvenanceDTO { * @return expiration time of the query results */ @XmlJavaTypeAdapter(TimestampAdapter.class) + @ApiModelProperty( + value = "The timestamp when the query will expire." + ) public Date getExpiration() { return expiration; } @@ -102,6 +118,9 @@ public class ProvenanceDTO { /** * @return percent completed */ + @ApiModelProperty( + value = "The current percent complete." + ) public Integer getPercentCompleted() { return percentCompleted; } @@ -113,6 +132,9 @@ public class ProvenanceDTO { /** * @return whether the query has finished */ + @ApiModelProperty( + value = "Whether the query has finished." + ) public Boolean isFinished() { return finished; } @@ -124,6 +146,9 @@ public class ProvenanceDTO { /** * @return provenance request */ + @ApiModelProperty( + value = "The provenance request." + ) public ProvenanceRequestDTO getRequest() { return request; } @@ -135,6 +160,9 @@ public class ProvenanceDTO { /** * @return results of this query */ + @ApiModelProperty( + value = "The provenance results." + ) public ProvenanceResultsDTO getResults() { return results; } 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/provenance/ProvenanceEventDTO.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/provenance/ProvenanceEventDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/ProvenanceEventDTO.java index 46c1074..dcc1461 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/ProvenanceEventDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/ProvenanceEventDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.provenance; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.Collection; import java.util.Date; import java.util.List; @@ -85,6 +86,9 @@ public class ProvenanceEventDTO { /** * @return event uuid */ + @ApiModelProperty( + value = "The event uuid." + ) public String getId() { return id; } @@ -96,6 +100,9 @@ public class ProvenanceEventDTO { /** * @return event id */ + @ApiModelProperty( + value = "The event id. This is a one up number thats unique per node." + ) public Long getEventId() { return eventId; } @@ -108,6 +115,9 @@ public class ProvenanceEventDTO { * @return time the event occurred */ @XmlJavaTypeAdapter(TimestampAdapter.class) + @ApiModelProperty( + value = "The timestamp of the event." + ) public Date getEventTime() { return eventTime; } @@ -119,6 +129,9 @@ public class ProvenanceEventDTO { /** * @return UUID of the FlowFile for this event */ + @ApiModelProperty( + value = "The uuid of the flowfile for the event." + ) public String getFlowFileUuid() { return flowFileUuid; } @@ -130,6 +143,9 @@ public class ProvenanceEventDTO { /** * @return size of the FlowFile for this event */ + @ApiModelProperty( + value = "The size of the flowfile for the event." + ) public String getFileSize() { return fileSize; } @@ -141,6 +157,9 @@ public class ProvenanceEventDTO { /** * @return size of the FlowFile in bytes for this event */ + @ApiModelProperty( + value = "The size of the flowfile in bytes for the event." + ) public Long getFileSizeBytes() { return fileSizeBytes; } @@ -152,6 +171,9 @@ public class ProvenanceEventDTO { /** * @return type of this event */ + @ApiModelProperty( + value = "The type of the event." + ) public String getEventType() { return eventType; } @@ -163,6 +185,9 @@ public class ProvenanceEventDTO { /** * @return attributes for the FlowFile for this event */ + @ApiModelProperty( + value = "The attributes of the flowfile for the event." + ) public Collection<AttributeDTO> getAttributes() { return attributes; } @@ -174,6 +199,9 @@ public class ProvenanceEventDTO { /** * @return id of the group that this component resides in. If the component is no longer in the flow, the group id will not be set */ + @ApiModelProperty( + value = "The id of the group that the component resides in. If the component is no longer in the flow, the group id will not be set." + ) public String getGroupId() { return groupId; } @@ -185,6 +213,9 @@ public class ProvenanceEventDTO { /** * @return id of the component that generated this event */ + @ApiModelProperty( + value = "The id of the component that generated the event." + ) public String getComponentId() { return componentId; } @@ -196,6 +227,9 @@ public class ProvenanceEventDTO { /** * @return name of the component that generated this event */ + @ApiModelProperty( + value = "The name of the component that generated the event." + ) public String getComponentName() { return componentName; } @@ -207,6 +241,9 @@ public class ProvenanceEventDTO { /** * @return type of the component that generated this event */ + @ApiModelProperty( + value = "The type of the component that generated the event." + ) public String getComponentType() { return componentType; } @@ -218,6 +255,9 @@ public class ProvenanceEventDTO { /** * @return source/destination system URI if the event was a RECEIVE/SEND */ + @ApiModelProperty( + value = "The source/destination system uri if the event was a RECEIVE/SEND." + ) public String getTransitUri() { return transitUri; } @@ -229,6 +269,9 @@ public class ProvenanceEventDTO { /** * @return alternate identifier URI for the FlowFile for this event */ + @ApiModelProperty( + value = "The alternate identifier uri for the fileflow for the event." + ) public String getAlternateIdentifierUri() { return alternateIdentifierUri; } @@ -240,6 +283,9 @@ public class ProvenanceEventDTO { /** * @return identifier of the node where this event originated */ + @ApiModelProperty( + value = "The identifier for the node where the event originated." + ) public String getClusterNodeId() { return clusterNodeId; } @@ -251,6 +297,9 @@ public class ProvenanceEventDTO { /** * @return label to use to show which node this event originated from */ + @ApiModelProperty( + value = "The label for the node where the event originated." + ) public String getClusterNodeAddress() { return clusterNodeAddress; } @@ -262,6 +311,9 @@ public class ProvenanceEventDTO { /** * @return parent uuids for this event */ + @ApiModelProperty( + value = "The parent uuids for the event." + ) public List<String> getParentUuids() { return parentUuids; } @@ -273,6 +325,9 @@ public class ProvenanceEventDTO { /** * @return child uuids for this event */ + @ApiModelProperty( + value = "The child uuids for the event." + ) public List<String> getChildUuids() { return childUuids; } @@ -284,6 +339,9 @@ public class ProvenanceEventDTO { /** * @return duration of the event, in milliseconds */ + @ApiModelProperty( + value = "The event duration in milliseconds." + ) public Long getEventDuration() { return eventDuration; } @@ -295,6 +353,9 @@ public class ProvenanceEventDTO { /** * @return duration since the lineage began, in milliseconds */ + @ApiModelProperty( + value = "The duration since the lineage began, in milliseconds." + ) public Long getLineageDuration() { return lineageDuration; } @@ -306,6 +367,9 @@ public class ProvenanceEventDTO { /** * @return source system FlowFile id */ + @ApiModelProperty( + value = "The source system flowfile id." + ) public String getSourceSystemFlowFileId() { return sourceSystemFlowFileId; } @@ -317,6 +381,9 @@ public class ProvenanceEventDTO { /** * @return If this represents a route event, this is the relationship to which the flowfile was routed */ + @ApiModelProperty( + value = "The relationship to which the flowfile was routed if the event is of type ROUTE." + ) public String getRelationship() { return relationship; } @@ -328,6 +395,9 @@ public class ProvenanceEventDTO { /** * @return event details */ + @ApiModelProperty( + value = "The event details." + ) public String getDetails() { return details; } @@ -339,6 +409,9 @@ public class ProvenanceEventDTO { /** * @return whether or not the input and output content claim is the same */ + @ApiModelProperty( + value = "Whether the input and output content claim is the same." + ) public Boolean getContentEqual() { return contentEqual; } @@ -350,6 +423,9 @@ public class ProvenanceEventDTO { /** * @return whether or not the output content is still available */ + @ApiModelProperty( + value = "Whether the output content is still available." + ) public Boolean getOutputContentAvailable() { return outputContentAvailable; } @@ -361,6 +437,9 @@ public class ProvenanceEventDTO { /** * @return the Section in which the output Content Claim lives, or <code>null</code> if no Content Claim exists */ + @ApiModelProperty( + value = "The section in which the output content claim lives." + ) public String getOutputContentClaimSection() { return outputContentClaimSection; } @@ -372,6 +451,9 @@ public class ProvenanceEventDTO { /** * @return the Container in which the output Content Claim lives, or <code>null</code> if no Content Claim exists */ + @ApiModelProperty( + value = "The container in which the output content claim lives." + ) public String getOutputContentClaimContainer() { return outputContentClaimContainer; } @@ -383,6 +465,9 @@ public class ProvenanceEventDTO { /** * @return the Identifier of the output Content Claim, or <code>null</code> if no Content Claim exists */ + @ApiModelProperty( + value = "The identifier of the output content claim." + ) public String getOutputContentClaimIdentifier() { return outputContentClaimIdentifier; } @@ -394,6 +479,9 @@ public class ProvenanceEventDTO { /** * @return the offset into the the output Content Claim where the FlowFile's content begins, or <code>null</code> if no Content Claim exists */ + @ApiModelProperty( + value = "The offset into the output content claim where the flowfiles content begins." + ) public Long getOutputContentClaimOffset() { return outputContentClaimOffset; } @@ -405,6 +493,9 @@ public class ProvenanceEventDTO { /** * @return the formatted file size of the input content claim */ + @ApiModelProperty( + value = "The file size of the output content claim formatted." + ) public String getOutputContentClaimFileSize() { return outputContentClaimFileSize; } @@ -416,6 +507,9 @@ public class ProvenanceEventDTO { /** * @return the number of bytes of the input content claim */ + @ApiModelProperty( + value = "The file size of the output content claim in bytes." + ) public Long getOutputContentClaimFileSizeBytes() { return outputContentClaimFileSizeBytes; } @@ -427,6 +521,9 @@ public class ProvenanceEventDTO { /** * @return whether or not the input content is still available */ + @ApiModelProperty( + value = "Whether the input content is still available." + ) public Boolean getInputContentAvailable() { return inputContentAvailable; } @@ -438,6 +535,9 @@ public class ProvenanceEventDTO { /** * @return the Section in which the input Content Claim lives, or <code>null</code> if no Content Claim exists */ + @ApiModelProperty( + value = "The section in which the input content claim lives." + ) public String getInputContentClaimSection() { return inputContentClaimSection; } @@ -449,6 +549,9 @@ public class ProvenanceEventDTO { /** * @return the Container in which the input Content Claim lives, or <code>null</code> if no Content Claim exists */ + @ApiModelProperty( + value = "The container in which the input content claim lives." + ) public String getInputContentClaimContainer() { return inputContentClaimContainer; } @@ -460,6 +563,9 @@ public class ProvenanceEventDTO { /** * @return the Identifier of the input Content Claim, or <code>null</code> if no Content Claim exists */ + @ApiModelProperty( + value = "The identifier of the input content claim." + ) public String getInputContentClaimIdentifier() { return inputContentClaimIdentifier; } @@ -471,6 +577,9 @@ public class ProvenanceEventDTO { /** * @return the offset into the the input Content Claim where the FlowFile's content begins, or <code>null</code> if no Content Claim exists */ + @ApiModelProperty( + value = "The offset into the input content claim where the flowfiles content begins." + ) public Long getInputContentClaimOffset() { return inputContentClaimOffset; } @@ -482,6 +591,9 @@ public class ProvenanceEventDTO { /** * @return the formatted file size of the input content claim */ + @ApiModelProperty( + value = "The file size of the input content claim formatted." + ) public String getInputContentClaimFileSize() { return inputContentClaimFileSize; } @@ -493,6 +605,9 @@ public class ProvenanceEventDTO { /** * @return the number of bytes of the input content claim */ + @ApiModelProperty( + value = "The file size of the intput content claim in bytes." + ) public Long getInputContentClaimFileSizeBytes() { return inputContentClaimFileSizeBytes; } @@ -504,6 +619,9 @@ public class ProvenanceEventDTO { /** * @return whether or not replay is available */ + @ApiModelProperty( + value = "Whether or not replay is available." + ) public Boolean getReplayAvailable() { return replayAvailable; } @@ -515,6 +633,9 @@ public class ProvenanceEventDTO { /** * @return the explanation as to why replay is unavailable */ + @ApiModelProperty( + value = "Explanation as to why replay is unavailable." + ) public String getReplayExplanation() { return replayExplanation; } @@ -527,6 +648,10 @@ public class ProvenanceEventDTO { * @return identifier of the FlowFile Queue / Connection from which the FlowFile was pulled to generate this event, or <code>null</code> if either the queue is unknown or the FlowFile was created * by this event */ + @ApiModelProperty( + value = "The identifier of the queue/connection from which the flowfile was pulled to genereate this event. May be null if the queue/connection is unknown or the " + + "flowfile was generated from this event." + ) public String getSourceConnectionIdentifier() { return sourceConnectionIdentifier; } 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/provenance/ProvenanceOptionsDTO.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/provenance/ProvenanceOptionsDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/ProvenanceOptionsDTO.java index 2c7f467..edd414f 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/ProvenanceOptionsDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/ProvenanceOptionsDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.provenance; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.List; import javax.xml.bind.annotation.XmlType; @@ -30,6 +31,9 @@ public class ProvenanceOptionsDTO { /** * @return available searchable fields for this NiFi instance */ + @ApiModelProperty( + value = "The available searchable field for the NiFi." + ) public List<ProvenanceSearchableFieldDTO> getSearchableFields() { return searchableFields; } 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/provenance/ProvenanceRequestDTO.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/provenance/ProvenanceRequestDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/ProvenanceRequestDTO.java index bc239ee..f38bc99 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/ProvenanceRequestDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/ProvenanceRequestDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.provenance; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.Date; import java.util.Map; @@ -39,6 +40,9 @@ public class ProvenanceRequestDTO { /** * @return the search terms to use for this search */ + @ApiModelProperty( + value = "The search terms used to perform the search." + ) public Map<String, String> getSearchTerms() { return searchTerms; } @@ -51,6 +55,9 @@ public class ProvenanceRequestDTO { * @return earliest event time to include in the query */ @XmlJavaTypeAdapter(DateTimeAdapter.class) + @ApiModelProperty( + value = "The earliest event time to include in the query." + ) public Date getStartDate() { return startDate; } @@ -63,6 +70,9 @@ public class ProvenanceRequestDTO { * @return latest event time to include in the query */ @XmlJavaTypeAdapter(DateTimeAdapter.class) + @ApiModelProperty( + value = "The latest event time to include in the query." + ) public Date getEndDate() { return endDate; } @@ -74,6 +84,9 @@ public class ProvenanceRequestDTO { /** * @return minimum file size to include in the query */ + @ApiModelProperty( + value = "The minimum file size to include in the query." + ) public String getMinimumFileSize() { return minimumFileSize; } @@ -85,6 +98,9 @@ public class ProvenanceRequestDTO { /** * @return maximum file size to include in the query */ + @ApiModelProperty( + value = "The maximum file size to include in the query." + ) public String getMaximumFileSize() { return maximumFileSize; } @@ -96,6 +112,9 @@ public class ProvenanceRequestDTO { /** * @return number of max results */ + @ApiModelProperty( + value = "The maximum number of results to include." + ) public Integer getMaxResults() { return maxResults; } 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/provenance/ProvenanceResultsDTO.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/provenance/ProvenanceResultsDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/ProvenanceResultsDTO.java index 6d2f64d..d37452d 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/ProvenanceResultsDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/ProvenanceResultsDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.provenance; +import com.wordnik.swagger.annotations.ApiModelProperty; import org.apache.nifi.web.api.dto.util.DateTimeAdapter; import org.apache.nifi.web.api.dto.util.TimeAdapter; @@ -43,6 +44,9 @@ public class ProvenanceResultsDTO { /** * @return error messages */ + @ApiModelProperty( + value = "Any errors that occurred while performing the provenance request." + ) public Set<String> getErrors() { return errors; } @@ -54,6 +58,9 @@ public class ProvenanceResultsDTO { /** * @return provenance events that matched the search criteria */ + @ApiModelProperty( + value = "The provenance events that matched the search criteria." + ) public List<ProvenanceEventDTO> getProvenanceEvents() { return provenanceEvents; } @@ -65,6 +72,9 @@ public class ProvenanceResultsDTO { /** * @return total number of results formatted */ + @ApiModelProperty( + value = "The total number of results formatted." + ) public String getTotal() { return total; } @@ -76,6 +86,9 @@ public class ProvenanceResultsDTO { /** * @return total number of results */ + @ApiModelProperty( + value = "The total number of results." + ) public Long getTotalCount() { return totalCount; } @@ -88,6 +101,9 @@ public class ProvenanceResultsDTO { * @return when the search was performed */ @XmlJavaTypeAdapter(TimeAdapter.class) + @ApiModelProperty( + value = "Then the search was performed." + ) public Date getGenerated() { return generated; } @@ -100,6 +116,9 @@ public class ProvenanceResultsDTO { * @return oldest event available in the provenance repository */ @XmlJavaTypeAdapter(DateTimeAdapter.class) + @ApiModelProperty( + value = "The oldest event available in the provenance repository." + ) public Date getOldestEvent() { return oldestEvent; } @@ -111,6 +130,9 @@ public class ProvenanceResultsDTO { /** * @return time offset on the server thats used for event time */ + @ApiModelProperty( + value = "The time offset of the server that's used for event time." + ) public Integer getTimeOffset() { return timeOffset; } 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/provenance/ProvenanceSearchableFieldDTO.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/provenance/ProvenanceSearchableFieldDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/ProvenanceSearchableFieldDTO.java index 97300f6..05a707e 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/ProvenanceSearchableFieldDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/ProvenanceSearchableFieldDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.provenance; +import com.wordnik.swagger.annotations.ApiModelProperty; import javax.xml.bind.annotation.XmlType; /** @@ -32,6 +33,9 @@ public class ProvenanceSearchableFieldDTO { /** * @return id of this searchable field */ + @ApiModelProperty( + value = "The id of the searchable field." + ) public String getId() { return id; } @@ -43,6 +47,9 @@ public class ProvenanceSearchableFieldDTO { /** * @return the field */ + @ApiModelProperty( + value = "The searchable field." + ) public String getField() { return field; } @@ -54,6 +61,9 @@ public class ProvenanceSearchableFieldDTO { /** * @return label for this field */ + @ApiModelProperty( + value = "The label for the searchable field." + ) public String getLabel() { return label; } @@ -65,6 +75,9 @@ public class ProvenanceSearchableFieldDTO { /** * @return type of this field */ + @ApiModelProperty( + value = "The type of the searchable field." + ) public String getType() { return type; } 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/provenance/lineage/LineageDTO.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/provenance/lineage/LineageDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/lineage/LineageDTO.java index 0ef8aab..bc68d78 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/lineage/LineageDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/lineage/LineageDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.provenance.lineage; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.Date; import javax.xml.bind.annotation.XmlType; import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter; @@ -42,6 +43,9 @@ public class LineageDTO { /** * @return id of this lineage */ + @ApiModelProperty( + value = "The id of this lineage query." + ) public String getId() { return id; } @@ -53,6 +57,9 @@ public class LineageDTO { /** * @return uri for this lineage */ + @ApiModelProperty( + value = "The URI for this lineage query for later retrieval and deletion." + ) public String getUri() { return uri; } @@ -64,6 +71,9 @@ public class LineageDTO { /** * @return id of the node in the cluster where this lineage originated */ + @ApiModelProperty( + value = "The id of the node where this lineage originated if clustered." + ) public String getClusterNodeId() { return clusterNodeId; } @@ -76,6 +86,9 @@ public class LineageDTO { * @return submission time for this lineage */ @XmlJavaTypeAdapter(TimestampAdapter.class) + @ApiModelProperty( + value = "When the lineage query was submitted." + ) public Date getSubmissionTime() { return submissionTime; } @@ -88,6 +101,9 @@ public class LineageDTO { * @return expiration of this lineage */ @XmlJavaTypeAdapter(TimestampAdapter.class) + @ApiModelProperty( + value = "When the lineage query will expire." + ) public Date getExpiration() { return expiration; } @@ -99,6 +115,9 @@ public class LineageDTO { /** * @return percent completed for this result */ + @ApiModelProperty( + value = "The percent complete for the lineage query." + ) public Integer getPercentCompleted() { return percentCompleted; } @@ -110,6 +129,9 @@ public class LineageDTO { /** * @return whether or not the request is finished running */ + @ApiModelProperty( + value = "Whether the lineage query has finished." + ) public Boolean getFinished() { return finished; } @@ -121,6 +143,9 @@ public class LineageDTO { /** * @return the lineage request */ + @ApiModelProperty( + value = "The initial lineage result." + ) public LineageRequestDTO getRequest() { return request; } @@ -132,6 +157,9 @@ public class LineageDTO { /** * @return the results of this lineage */ + @ApiModelProperty( + value = "The results of the lineage query." + ) public LineageResultsDTO getResults() { return results; } 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/provenance/lineage/LineageRequestDTO.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/provenance/lineage/LineageRequestDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/lineage/LineageRequestDTO.java index 2494962..afab621 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/lineage/LineageRequestDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/lineage/LineageRequestDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.provenance.lineage; +import com.wordnik.swagger.annotations.ApiModelProperty; import javax.xml.bind.annotation.XmlEnum; import javax.xml.bind.annotation.XmlType; @@ -31,7 +32,6 @@ public class LineageRequestDTO { @XmlType(name = "lineageRequestType") @XmlEnum public enum LineageRequestType { - PARENTS, CHILDREN, FLOWFILE; @@ -45,6 +45,9 @@ public class LineageRequestDTO { /** * @return event id that was used to generate this lineage */ + @ApiModelProperty( + value = "" + ) public Long getEventId() { return eventId; } @@ -57,6 +60,11 @@ public class LineageRequestDTO { * @return type of lineage request. Either 'PARENTS', 'CHILDREN', or 'FLOWFILE'. PARENTS will return the lineage for the flowfiles that are parents of the specified event. CHILDREN will return the * lineage of for the flowfiles that are children of the specified event. FLOWFILE will return the lineage for the specified flowfile. */ + @ApiModelProperty( + value = "The type of lineage request. PARENTS will return the lineage for the flowfiles that are parents of the specified event. CHILDREN will return the lineage " + + "for the flowfiles that are children of the specified event. FLOWFILE will return the lineage for the specified flowfile.", + allowableValues = "PARENTS, CHILDREN, and FLOWFILE" + ) public LineageRequestType getLineageRequestType() { return lineageRequestType; } @@ -68,6 +76,9 @@ public class LineageRequestDTO { /** * @return uuid that was used to generate this lineage */ + @ApiModelProperty( + value = "The uuid that was used to generate the lineage." + ) public String getUuid() { return uuid; } 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/provenance/lineage/LineageResultsDTO.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/provenance/lineage/LineageResultsDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/lineage/LineageResultsDTO.java index 8876e9e..0ac4479 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/lineage/LineageResultsDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/lineage/LineageResultsDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.provenance.lineage; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.List; import java.util.Set; import javax.xml.bind.annotation.XmlType; @@ -34,6 +35,9 @@ public class LineageResultsDTO { /** * @return any error messages */ + @ApiModelProperty( + value = "Any errors that occurred while generating the lineage." + ) public Set<String> getErrors() { return errors; } @@ -45,6 +49,9 @@ public class LineageResultsDTO { /** * @return the nodes */ + @ApiModelProperty( + value = "The nodes in the lineage." + ) public List<ProvenanceNodeDTO> getNodes() { return nodes; } @@ -56,6 +63,9 @@ public class LineageResultsDTO { /** * @return the links */ + @ApiModelProperty( + value = "The links between the nodes in the lineage." + ) public List<ProvenanceLinkDTO> getLinks() { return links; } 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/provenance/lineage/ProvenanceLinkDTO.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/provenance/lineage/ProvenanceLinkDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/lineage/ProvenanceLinkDTO.java index d002626..f91d124 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/lineage/ProvenanceLinkDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/lineage/ProvenanceLinkDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.provenance.lineage; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.Date; import javax.xml.bind.annotation.XmlType; import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter; @@ -36,6 +37,9 @@ public class ProvenanceLinkDTO { /** * @return source node id */ + @ApiModelProperty( + value = "The source node id of the link." + ) public String getSourceId() { return sourceId; } @@ -47,6 +51,9 @@ public class ProvenanceLinkDTO { /** * @return target node id */ + @ApiModelProperty( + value = "The target node id of the link." + ) public String getTargetId() { return targetId; } @@ -58,6 +65,9 @@ public class ProvenanceLinkDTO { /** * @return flowfile uuid that traversed this link */ + @ApiModelProperty( + value = "The flowfile uuid that traversed the link." + ) public String getFlowFileUuid() { return flowFileUuid; } @@ -70,6 +80,9 @@ public class ProvenanceLinkDTO { * @return timestamp of this link (based on the destination) */ @XmlJavaTypeAdapter(TimestampAdapter.class) + @ApiModelProperty( + value = "The timestamp of the link (based on the destination)." + ) public Date getTimestamp() { return timestamp; } @@ -81,6 +94,9 @@ public class ProvenanceLinkDTO { /** * @return number of millis since epoch */ + @ApiModelProperty( + value = "The timestamp of this link in milliseconds." + ) public Long getMillis() { return millis; } 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/provenance/lineage/ProvenanceNodeDTO.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/provenance/lineage/ProvenanceNodeDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/lineage/ProvenanceNodeDTO.java index b517751..5e7e329 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/lineage/ProvenanceNodeDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/lineage/ProvenanceNodeDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.provenance.lineage; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.Date; import java.util.List; @@ -43,6 +44,9 @@ public class ProvenanceNodeDTO { /** * @return id of the node */ + @ApiModelProperty( + value = "The id of the node." + ) public String getId() { return id; } @@ -54,6 +58,9 @@ public class ProvenanceNodeDTO { /** * @return flowfile uuid for this provenance event */ + @ApiModelProperty( + value = "The uuid of the flowfile associated with the provenance event." + ) public String getFlowFileUuid() { return flowFileUuid; } @@ -65,6 +72,9 @@ public class ProvenanceNodeDTO { /** * @return parent flowfile uuids for this provenance event */ + @ApiModelProperty( + value = "The uuid of the parent flowfiles of the provenance event." + ) public List<String> getParentUuids() { return parentUuids; } @@ -76,6 +86,9 @@ public class ProvenanceNodeDTO { /** * @return child flowfile uuids for this provenance event */ + @ApiModelProperty( + value = "The uuid of the childrent flowfiles of the provenance event." + ) public List<String> getChildUuids() { return childUuids; } @@ -87,6 +100,9 @@ public class ProvenanceNodeDTO { /** * @return node identifier that this event/flowfile originated from */ + @ApiModelProperty( + value = "The identifier of the node that this event/flowfile originated from." + ) public String getClusterNodeIdentifier() { return clusterNodeIdentifier; } @@ -98,6 +114,10 @@ public class ProvenanceNodeDTO { /** * @return type of node */ + @ApiModelProperty( + value = "The type of the node.", + allowableValues = "FLOWFILE, EVENT" + ) public String getType() { return type; } @@ -109,6 +129,9 @@ public class ProvenanceNodeDTO { /** * @return this is an event node, this is the type of event */ + @ApiModelProperty( + value = "If the type is EVENT, this is the type of event." + ) public String getEventType() { return eventType; } @@ -121,6 +144,9 @@ public class ProvenanceNodeDTO { * @return timestamp of this node */ @XmlJavaTypeAdapter(TimestampAdapter.class) + @ApiModelProperty( + value = "The timestamp of the node formatted." + ) public Date getTimestamp() { return timestamp; } @@ -132,6 +158,9 @@ public class ProvenanceNodeDTO { /** * @return number of millis since epoch */ + @ApiModelProperty( + value = "The timestamp of the node in milliseconds." + ) public Long getMillis() { return millis; } 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/search/ComponentSearchResultDTO.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/search/ComponentSearchResultDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/ComponentSearchResultDTO.java index 01965f9..8e9cba5 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/ComponentSearchResultDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/ComponentSearchResultDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.search; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.List; import javax.xml.bind.annotation.XmlType; @@ -33,6 +34,9 @@ public class ComponentSearchResultDTO { /** * @return id of the component that matched */ + @ApiModelProperty( + value = "The id of the component that matched the search." + ) public String getId() { return id; } @@ -44,6 +48,9 @@ public class ComponentSearchResultDTO { /** * @return group id of the component that matched */ + @ApiModelProperty( + value = "The group id of the component that matched the search." + ) public String getGroupId() { return groupId; } @@ -55,6 +62,9 @@ public class ComponentSearchResultDTO { /** * @return name of the component that matched */ + @ApiModelProperty( + value = "The name of the component that matched the search." + ) public String getName() { return name; } @@ -66,6 +76,9 @@ public class ComponentSearchResultDTO { /** * @return What matched the search string for this component */ + @ApiModelProperty( + value = "What matched the search from the component." + ) public List<String> getMatches() { return matches; } 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/search/NodeSearchResultDTO.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/search/NodeSearchResultDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/NodeSearchResultDTO.java index ab78d06..554966e 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/NodeSearchResultDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/NodeSearchResultDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.search; +import com.wordnik.swagger.annotations.ApiModelProperty; import javax.xml.bind.annotation.XmlType; /** @@ -30,6 +31,9 @@ public class NodeSearchResultDTO { /** * @return id of the node that was matched */ + @ApiModelProperty( + value = "The id of the node that matched the search." + ) public String getId() { return id; } @@ -41,6 +45,9 @@ public class NodeSearchResultDTO { /** * @return address of the node that was matched */ + @ApiModelProperty( + value = "The address of the node that matched the search." + ) public String getAddress() { return address; } 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/search/SearchResultsDTO.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/search/SearchResultsDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/SearchResultsDTO.java index 0319916..60e5bdd 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/SearchResultsDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/SearchResultsDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.search; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.ArrayList; import java.util.List; import javax.xml.bind.annotation.XmlType; @@ -37,6 +38,9 @@ public class SearchResultsDTO { /** * @return The processors that matched the search */ + @ApiModelProperty( + value = "The processors that matched the search." + ) public List<ComponentSearchResultDTO> getProcessorResults() { return processorResults; } @@ -48,6 +52,9 @@ public class SearchResultsDTO { /** * @return connections that matched the search */ + @ApiModelProperty( + value = "The connections that matched the search." + ) public List<ComponentSearchResultDTO> getConnectionResults() { return connectionResults; } @@ -59,6 +66,9 @@ public class SearchResultsDTO { /** * @return process group that matched the search */ + @ApiModelProperty( + value = "The process groups that matched the search." + ) public List<ComponentSearchResultDTO> getProcessGroupResults() { return processGroupResults; } @@ -70,6 +80,9 @@ public class SearchResultsDTO { /** * @return input ports that matched the search */ + @ApiModelProperty( + value = "The input ports that matched the search." + ) public List<ComponentSearchResultDTO> getInputPortResults() { return inputPortResults; } @@ -77,6 +90,9 @@ public class SearchResultsDTO { /** * @return output ports that matched the search */ + @ApiModelProperty( + value = "The output ports that matched the search." + ) public List<ComponentSearchResultDTO> getOutputPortResults() { return outputPortResults; } @@ -92,6 +108,9 @@ public class SearchResultsDTO { /** * @return remote process groups that matched the search */ + @ApiModelProperty( + value = "The remote process groups that matched the search." + ) public List<ComponentSearchResultDTO> getRemoteProcessGroupResults() { return remoteProcessGroupResults; } @@ -103,6 +122,9 @@ public class SearchResultsDTO { /** * @return funnels that matched the search */ + @ApiModelProperty( + value = "The funnels that matched the search." + ) public List<ComponentSearchResultDTO> getFunnelResults() { return funnelResults; } 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/search/UserGroupSearchResultDTO.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/search/UserGroupSearchResultDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/UserGroupSearchResultDTO.java index 863ba3a..ef81b88 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/UserGroupSearchResultDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/UserGroupSearchResultDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.search; +import com.wordnik.swagger.annotations.ApiModelProperty; import javax.xml.bind.annotation.XmlType; /** @@ -29,6 +30,9 @@ public class UserGroupSearchResultDTO { /** * @return name of the group that matched */ + @ApiModelProperty( + value = "The name of the group that matched the search." + ) public String getGroup() { return group; } 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/search/UserSearchResultDTO.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/search/UserSearchResultDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/UserSearchResultDTO.java index b68ab0f..8bed771 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/UserSearchResultDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/UserSearchResultDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.search; +import com.wordnik.swagger.annotations.ApiModelProperty; import javax.xml.bind.annotation.XmlType; /** @@ -30,6 +31,9 @@ public class UserSearchResultDTO { /** * @return dn of the user that matched */ + @ApiModelProperty( + value = "The dn of the user that matched the search." + ) public String getUserDn() { return userDn; } @@ -41,6 +45,9 @@ public class UserSearchResultDTO { /** * @return username of user that matched */ + @ApiModelProperty( + value = "The name of the user that matched the search." + ) 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/status/ClusterConnectionStatusDTO.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/status/ClusterConnectionStatusDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterConnectionStatusDTO.java index 248729e..34f900f 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterConnectionStatusDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterConnectionStatusDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.status; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.Collection; import java.util.Date; import javax.xml.bind.annotation.XmlType; @@ -37,6 +38,9 @@ public class ClusterConnectionStatusDTO { * @return time the status were last refreshed */ @XmlJavaTypeAdapter(TimeAdapter.class) + @ApiModelProperty( + value = "The time the status was last refreshed." + ) public Date getStatsLastRefreshed() { return statsLastRefreshed; } @@ -48,6 +52,9 @@ public class ClusterConnectionStatusDTO { /** * @return connection id */ + @ApiModelProperty( + value = "The id of the connection." + ) public String getConnectionId() { return connectionId; } @@ -59,6 +66,9 @@ public class ClusterConnectionStatusDTO { /** * @return connection name */ + @ApiModelProperty( + value = "The name of the connection." + ) public String getConnectionName() { return connectionName; } @@ -70,6 +80,9 @@ public class ClusterConnectionStatusDTO { /** * @return The collection of node connection status DTO */ + @ApiModelProperty( + value = "The connection status for each node." + ) public Collection<NodeConnectionStatusDTO> getNodeConnectionStatus() { return nodeConnectionStatus; } 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/status/ClusterPortStatusDTO.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/status/ClusterPortStatusDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterPortStatusDTO.java index ca4ef07..372bb70 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterPortStatusDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterPortStatusDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.status; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.Collection; import java.util.Date; import javax.xml.bind.annotation.XmlType; @@ -37,6 +38,9 @@ public class ClusterPortStatusDTO { * @return the time the status were last refreshed */ @XmlJavaTypeAdapter(TimeAdapter.class) + @ApiModelProperty( + value = "The time the status was last refreshed." + ) public Date getStatsLastRefreshed() { return statsLastRefreshed; } @@ -48,6 +52,9 @@ public class ClusterPortStatusDTO { /** * @return port status from each node in the cluster */ + @ApiModelProperty( + value = "The port status for each node." + ) public Collection<NodePortStatusDTO> getNodePortStatus() { return nodePortStatus; } @@ -59,6 +66,9 @@ public class ClusterPortStatusDTO { /** * @return port id */ + @ApiModelProperty( + value = "The id of the port." + ) public String getPortId() { return portId; } @@ -70,6 +80,9 @@ public class ClusterPortStatusDTO { /** * @return port name */ + @ApiModelProperty( + value = "The name of the port." + ) public String getPortName() { return portName; } 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/status/ClusterProcessGroupStatusDTO.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/status/ClusterProcessGroupStatusDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterProcessGroupStatusDTO.java index 08d76a5..1a4ad63 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterProcessGroupStatusDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterProcessGroupStatusDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.status; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.Collection; import java.util.Date; import javax.xml.bind.annotation.XmlType; @@ -39,6 +40,9 @@ public class ClusterProcessGroupStatusDTO { * @return The time the status were last refreshed */ @XmlJavaTypeAdapter(TimeAdapter.class) + @ApiModelProperty( + value = "The time when the stats was last refreshed." + ) public Date getStatsLastRefreshed() { return statsLastRefreshed; } @@ -52,6 +56,9 @@ public class ClusterProcessGroupStatusDTO { * * @return The process group id */ + @ApiModelProperty( + value = "The id of the process group." + ) public String getProcessGroupId() { return processGroupId; } @@ -65,6 +72,9 @@ public class ClusterProcessGroupStatusDTO { * * @return The process group name */ + @ApiModelProperty( + value = "The name of the process group." + ) public String getProcessGroupName() { return processGroupName; } @@ -78,6 +88,9 @@ public class ClusterProcessGroupStatusDTO { * * @return The collection of node process group status DTO */ + @ApiModelProperty( + value = "The process groups status for each node." + ) public Collection<NodeProcessGroupStatusDTO> getNodeProcessGroupStatus() { return nodeProcessGroupStatus; } 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/status/ClusterProcessorStatusDTO.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/status/ClusterProcessorStatusDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterProcessorStatusDTO.java index 8d78b1f..faedc57 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterProcessorStatusDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterProcessorStatusDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.status; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.Collection; import java.util.Date; import javax.xml.bind.annotation.XmlType; @@ -39,6 +40,9 @@ public class ClusterProcessorStatusDTO { * @return time the status were last refreshed */ @XmlJavaTypeAdapter(TimeAdapter.class) + @ApiModelProperty( + value = "The time when the status was last refreshed." + ) public Date getStatsLastRefreshed() { return statsLastRefreshed; } @@ -50,6 +54,9 @@ public class ClusterProcessorStatusDTO { /** * @return processor id */ + @ApiModelProperty( + value = "The processor id." + ) public String getProcessorId() { return processorId; } @@ -61,6 +68,9 @@ public class ClusterProcessorStatusDTO { /** * @return processor name */ + @ApiModelProperty( + value = "The processor name." + ) public String getProcessorName() { return processorName; } @@ -72,6 +82,9 @@ public class ClusterProcessorStatusDTO { /** * @return processor type */ + @ApiModelProperty( + value = "The processor type." + ) public String getProcessorType() { return processorType; } @@ -83,6 +96,10 @@ public class ClusterProcessorStatusDTO { /** * @return processor run status */ + @ApiModelProperty( + value = "The processor state.", + allowableValues = "RUNNING, STOPPED, DISABLED, INVALID" + ) public String getProcessorRunStatus() { return processorRunStatus; } @@ -96,6 +113,9 @@ public class ClusterProcessorStatusDTO { * * @return The collection of node processor status DTO */ + @ApiModelProperty( + value = "The processor status for each node." + ) public Collection<NodeProcessorStatusDTO> getNodeProcessorStatus() { return nodeProcessorStatus; } 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/status/ClusterRemoteProcessGroupStatusDTO.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/status/ClusterRemoteProcessGroupStatusDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterRemoteProcessGroupStatusDTO.java index 027bf4f..5fef96f 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterRemoteProcessGroupStatusDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterRemoteProcessGroupStatusDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.status; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.Collection; import java.util.Date; import javax.xml.bind.annotation.XmlType; @@ -37,6 +38,9 @@ public class ClusterRemoteProcessGroupStatusDTO { * @return the time the status were last refreshed */ @XmlJavaTypeAdapter(TimeAdapter.class) + @ApiModelProperty( + value = "The time when the remote process group status was last refreshed." + ) public Date getStatsLastRefreshed() { return statsLastRefreshed; } @@ -48,6 +52,9 @@ public class ClusterRemoteProcessGroupStatusDTO { /** * @return remote process group status from each node in the cluster */ + @ApiModelProperty( + value = "The remote process group status from each node in the cluster." + ) public Collection<NodeRemoteProcessGroupStatusDTO> getNodeRemoteProcessGroupStatus() { return nodeRemoteProcessGroupStatus; } @@ -59,6 +66,9 @@ public class ClusterRemoteProcessGroupStatusDTO { /** * @return remote process group id */ + @ApiModelProperty( + value = "The id of the remote process group." + ) public String getRemoteProcessGroupId() { return remoteProcessGroupId; } @@ -70,6 +80,9 @@ public class ClusterRemoteProcessGroupStatusDTO { /** * @return remote process group name */ + @ApiModelProperty( + value = "The name of the remote process group." + ) public String getRemoteProcessGroupName() { return remoteProcessGroupName; } 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/status/ClusterStatusDTO.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/status/ClusterStatusDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterStatusDTO.java index e170c8b..73529d0 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterStatusDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterStatusDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.status; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.Collection; import javax.xml.bind.annotation.XmlType; @@ -31,6 +32,9 @@ public class ClusterStatusDTO { /** * @return collection of the node status DTOs */ + @ApiModelProperty( + value = "The status of each node." + ) public Collection<NodeStatusDTO> getNodeStatus() { return nodeStatus; } 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/status/ClusterStatusHistoryDTO.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/status/ClusterStatusHistoryDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterStatusHistoryDTO.java index a22c872..997e24b 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterStatusHistoryDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterStatusHistoryDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.status; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.Collection; import java.util.Date; import javax.xml.bind.annotation.XmlType; @@ -36,6 +37,9 @@ public class ClusterStatusHistoryDTO { * @return when this status history was generated */ @XmlJavaTypeAdapter(TimeAdapter.class) + @ApiModelProperty( + value = "When the status history was generated." + ) public Date getGenerated() { return generated; } @@ -47,6 +51,9 @@ public class ClusterStatusHistoryDTO { /** * @return status history from each node in the cluster */ + @ApiModelProperty( + value = "The status history from each node." + ) public Collection<NodeStatusHistoryDTO> getNodeStatusHistory() { return nodeStatusHistory; } @@ -58,6 +65,9 @@ public class ClusterStatusHistoryDTO { /** * @return status history for this component across the entire cluster */ + @ApiModelProperty( + value = "The status history for the entire cluster." + ) public StatusHistoryDTO getClusterStatusHistory() { return clusterStatusHistory; } 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/status/ConnectionStatusDTO.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/status/ConnectionStatusDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ConnectionStatusDTO.java index 2abc6ff..dc17c21 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ConnectionStatusDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ConnectionStatusDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.status; +import com.wordnik.swagger.annotations.ApiModelProperty; import javax.xml.bind.annotation.XmlType; /** @@ -42,6 +43,9 @@ public class ConnectionStatusDTO { /** * @return The connection id */ + @ApiModelProperty( + value = "The id of the connection." + ) public String getId() { return id; } @@ -51,8 +55,11 @@ public class ConnectionStatusDTO { } /** - * @return the ID of the Process Group to which this processor belongs. + * @return the ID of the Process Group to which this connection belongs. */ + @ApiModelProperty( + value = "The id of the process group the connection belongs to." + ) public String getGroupId() { return groupId; } @@ -64,6 +71,9 @@ public class ConnectionStatusDTO { /** * @return name of this connection */ + @ApiModelProperty( + value = "The name of the connection." + ) public String getName() { return name; } @@ -75,6 +85,9 @@ public class ConnectionStatusDTO { /** * @return total count of flow files that are queued */ + @ApiModelProperty( + value = "The number of flowfiles that are queued." + ) public String getQueuedCount() { return queuedCount; } @@ -86,6 +99,9 @@ public class ConnectionStatusDTO { /** * @return total size of flow files that are queued */ + @ApiModelProperty( + value = "The total size of flowfiles that are queued formatted." + ) public String getQueuedSize() { return queuedSize; } @@ -97,6 +113,9 @@ public class ConnectionStatusDTO { /** * @return The total count and size of queued flow files */ + @ApiModelProperty( + value = "The total count and size of queued flowfiles formatted." + ) public String getQueued() { return queued; } @@ -108,6 +127,9 @@ public class ConnectionStatusDTO { /** * @return id of the source of this connection */ + @ApiModelProperty( + value = "The id of the source of the connection." + ) public String getSourceId() { return sourceId; } @@ -119,6 +141,9 @@ public class ConnectionStatusDTO { /** * @return name of the source of this connection */ + @ApiModelProperty( + value = "The name of the source of the connection." + ) public String getSourceName() { return sourceName; } @@ -130,6 +155,9 @@ public class ConnectionStatusDTO { /** * @return id of the destination of this connection */ + @ApiModelProperty( + value = "The id of the destination of the connection." + ) public String getDestinationId() { return destinationId; } @@ -141,6 +169,9 @@ public class ConnectionStatusDTO { /** * @return name of the destination of this connection */ + @ApiModelProperty( + value = "The name of the destination of the connection." + ) public String getDestinationName() { return destinationName; } @@ -152,6 +183,9 @@ public class ConnectionStatusDTO { /** * @return input for this connection */ + @ApiModelProperty( + value = "The input count/size for the connection in the last 5 minutes." + ) public String getInput() { return input; } @@ -163,6 +197,9 @@ public class ConnectionStatusDTO { /** * @return output for this connection */ + @ApiModelProperty( + value = "The output count/sie for the connection in the last 5 minutes." + ) public String getOutput() { return output; }
