Repository: incubator-nifi Updated Branches: refs/heads/NIFI-292 5984b9528 -> 1da019d71
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/1da019d7 Tree: http://git-wip-us.apache.org/repos/asf/incubator-nifi/tree/1da019d7 Diff: http://git-wip-us.apache.org/repos/asf/incubator-nifi/diff/1da019d7 Branch: refs/heads/NIFI-292 Commit: 1da019d71ff265f3ee98d83c5bc9fb8fd8efb750 Parents: 5984b95 Author: Matt Gilman <[email protected]> Authored: Wed Apr 29 17:17:08 2015 -0400 Committer: Matt Gilman <[email protected]> Committed: Wed Apr 29 17:17:08 2015 -0400 ---------------------------------------------------------------------- .../nifi/web/api/dto/action/ActionDTO.java | 31 +++++ .../nifi/web/api/dto/action/HistoryDTO.java | 10 ++ .../web/api/dto/action/HistoryQueryDTO.java | 25 ++++ .../component/details/ExtensionDetailsDTO.java | 4 + .../details/RemoteProcessGroupDetailsDTO.java | 4 + .../dto/action/details/ConfigureDetailsDTO.java | 10 ++ .../dto/action/details/ConnectDetailsDTO.java | 22 ++++ .../api/dto/action/details/MoveDetailsDTO.java | 13 ++ .../api/dto/action/details/PurgeDetailsDTO.java | 4 + .../web/api/dto/provenance/AttributeDTO.java | 10 ++ .../web/api/dto/provenance/ProvenanceDTO.java | 28 +++++ .../api/dto/provenance/ProvenanceEventDTO.java | 125 +++++++++++++++++++ .../dto/provenance/ProvenanceOptionsDTO.java | 4 + .../dto/provenance/ProvenanceRequestDTO.java | 19 +++ .../dto/provenance/ProvenanceResultsDTO.java | 22 ++++ .../ProvenanceSearchableFieldDTO.java | 13 ++ 16 files changed, 344 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/1da019d7/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/ActionDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/ActionDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/ActionDTO.java index 357dd0f..d4dea38 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/ActionDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/ActionDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.action; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.Date; import javax.xml.bind.annotation.XmlType; import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter; @@ -45,6 +46,9 @@ public class ActionDTO { /** * @return action id */ + @ApiModelProperty( + value = "The action id." + ) public Integer getId() { return id; } @@ -56,6 +60,9 @@ public class ActionDTO { /** * @return user dn who perform this action */ + @ApiModelProperty( + value = "The dn of the user that performed the action." + ) public String getUserDn() { return userDn; } @@ -67,6 +74,9 @@ public class ActionDTO { /** * @return user name who perform this action */ + @ApiModelProperty( + value = "The name of the user that performed the action." + ) public String getUserName() { return userName; } @@ -79,6 +89,9 @@ public class ActionDTO { * @return action's timestamp */ @XmlJavaTypeAdapter(DateTimeAdapter.class) + @ApiModelProperty( + value = "The timestamp of the action." + ) public Date getTimestamp() { return timestamp; } @@ -90,6 +103,9 @@ public class ActionDTO { /** * @return id of the source component of this action */ + @ApiModelProperty( + value = "The id of the source component." + ) public String getSourceId() { return sourceId; } @@ -101,6 +117,9 @@ public class ActionDTO { /** * @return name of the source component of this action */ + @ApiModelProperty( + value = "The name of the source component." + ) public String getSourceName() { return sourceName; } @@ -112,6 +131,9 @@ public class ActionDTO { /** * @return type of the source component of this action */ + @ApiModelProperty( + value = "The type of the source component." + ) public String getSourceType() { return sourceType; } @@ -123,6 +145,9 @@ public class ActionDTO { /** * @return component details (if any) for this action */ + @ApiModelProperty( + value = "The details of the source component." + ) public ComponentDetailsDTO getComponentDetails() { return componentDetails; } @@ -134,6 +159,9 @@ public class ActionDTO { /** * @return operation being performed in this action */ + @ApiModelProperty( + value = "The operation that was performed." + ) public String getOperation() { return operation; } @@ -145,6 +173,9 @@ public class ActionDTO { /** * @return action details (if any) for this action */ + @ApiModelProperty( + value = "The details of the action." + ) public ActionDetailsDTO getActionDetails() { return actionDetails; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/1da019d7/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/HistoryDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/HistoryDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/HistoryDTO.java index 36a5e47..597ef0b 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/HistoryDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/HistoryDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.action; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.Collection; import java.util.Date; import javax.xml.bind.annotation.XmlType; @@ -35,6 +36,9 @@ public class HistoryDTO { /** * @return total number of actions */ + @ApiModelProperty( + value = "The number of number of actions that matched the search criteria.." + ) public Integer getTotal() { return total; } @@ -47,6 +51,9 @@ public class HistoryDTO { * @return timestamp when these records were returned */ @XmlJavaTypeAdapter(TimeAdapter.class) + @ApiModelProperty( + value = "The timestamp when the report was generated." + ) public Date getLastRefreshed() { return lastRefreshed; } @@ -58,6 +65,9 @@ public class HistoryDTO { /** * @return actions for this range */ + @ApiModelProperty( + value = "The actions." + ) public Collection<ActionDTO> getActions() { return actions; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/1da019d7/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/HistoryQueryDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/HistoryQueryDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/HistoryQueryDTO.java index 48a1321..7d4d21d 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/HistoryQueryDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/HistoryQueryDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.action; +import com.wordnik.swagger.annotations.ApiModelProperty; import java.util.Date; import javax.xml.bind.annotation.XmlType; import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter; @@ -39,6 +40,9 @@ public class HistoryQueryDTO { /** * @return user name */ + @ApiModelProperty( + value = "The name of the source component." + ) public String getUserName() { return userName; } @@ -50,6 +54,9 @@ public class HistoryQueryDTO { /** * @return source component id */ + @ApiModelProperty( + value = "The id of the source component." + ) public String getSourceId() { return sourceId; } @@ -62,6 +69,9 @@ public class HistoryQueryDTO { * @return start date */ @XmlJavaTypeAdapter(DateTimeAdapter.class) + @ApiModelProperty( + value = "The start date of actions to return." + ) public Date getStartDate() { return startDate; } @@ -74,6 +84,9 @@ public class HistoryQueryDTO { * @return end date */ @XmlJavaTypeAdapter(DateTimeAdapter.class) + @ApiModelProperty( + value = "The end date of actions to return." + ) public Date getEndDate() { return endDate; } @@ -85,6 +98,9 @@ public class HistoryQueryDTO { /** * @return offset */ + @ApiModelProperty( + value = "The offset into the result set." + ) public Integer getOffset() { return offset; } @@ -96,6 +112,9 @@ public class HistoryQueryDTO { /** * @return desired row count */ + @ApiModelProperty( + value = "The number of actions to return." + ) public Integer getCount() { return count; } @@ -107,6 +126,9 @@ public class HistoryQueryDTO { /** * @return desired sort column */ + @ApiModelProperty( + value = "The field to sort on." + ) public String getSortColumn() { return sortColumn; } @@ -118,6 +140,9 @@ public class HistoryQueryDTO { /** * @return desired sort order */ + @ApiModelProperty( + value = "The sort order." + ) public String getSortOrder() { return sortOrder; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/1da019d7/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/component/details/ExtensionDetailsDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/component/details/ExtensionDetailsDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/component/details/ExtensionDetailsDTO.java index 90eb5f0..81f87c1 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/component/details/ExtensionDetailsDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/component/details/ExtensionDetailsDTO.java @@ -16,6 +16,7 @@ */ package org.apache.nifi.web.api.dto.action.component.details; +import com.wordnik.swagger.annotations.ApiModelProperty; import javax.xml.bind.annotation.XmlType; /** @@ -29,6 +30,9 @@ public class ExtensionDetailsDTO extends ComponentDetailsDTO { /** * @return extension type */ + @ApiModelProperty( + value = "The fully qualified type of extension." + ) public String getType() { return type; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/1da019d7/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/1da019d7/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/1da019d7/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/1da019d7/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/1da019d7/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/1da019d7/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/1da019d7/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/1da019d7/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/1da019d7/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/1da019d7/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/1da019d7/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/1da019d7/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; }
