NIFI-292:
- Adding more comments.
- Adding another example.

Project: http://git-wip-us.apache.org/repos/asf/incubator-nifi/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-nifi/commit/a297cd49
Tree: http://git-wip-us.apache.org/repos/asf/incubator-nifi/tree/a297cd49
Diff: http://git-wip-us.apache.org/repos/asf/incubator-nifi/diff/a297cd49

Branch: refs/heads/NIFI-292
Commit: a297cd493a38a762a5eb51779f0d705e83e2ea7f
Parents: 6f5b622
Author: Matt Gilman <[email protected]>
Authored: Fri May 1 15:38:32 2015 -0400
Committer: Matt Gilman <[email protected]>
Committed: Fri May 1 15:38:32 2015 -0400

----------------------------------------------------------------------
 .../src/main/java/org/apache/nifi/web/api/ControllerResource.java | 3 ++-
 .../main/java/org/apache/nifi/web/api/ProcessGroupResource.java   | 2 ++
 .../nifi-web-api/src/main/resources/templates/index.html.hbs      | 2 +-
 3 files changed, 5 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a297cd49/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ControllerResource.java
----------------------------------------------------------------------
diff --git 
a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ControllerResource.java
 
b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ControllerResource.java
index 1fc293b..4883721 100644
--- 
a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ControllerResource.java
+++ 
b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ControllerResource.java
@@ -238,7 +238,8 @@ public class ControllerResource extends ApplicationResource 
{
     )
     public ProcessGroupResource getGroupResource(
             @ApiParam(
-                    value = "The id of the process group that is the parent of 
the requested resource(s).",
+                    value = "The id of the process group that is the parent of 
the requested resource(s). If the desired process group is "
+                            + "the root group an alias 'root' may be used as 
the process-group-id.",
                     required = true
             )
             @PathParam("process-group-id") String groupId) {

http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a297cd49/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ProcessGroupResource.java
----------------------------------------------------------------------
diff --git 
a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ProcessGroupResource.java
 
b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ProcessGroupResource.java
index a05b64a..3e82bad 100644
--- 
a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ProcessGroupResource.java
+++ 
b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ProcessGroupResource.java
@@ -1252,6 +1252,8 @@ public class ProcessGroupResource extends 
ApplicationResource {
     @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN', 
'ROLE_NIFI')")
     @ApiOperation(
             value = "Gets the status for a process group",
+            notes = "The status for a process group includes status for all 
descendent components. When invoked on the root group with "
+                    + "recursive set to true, it will return the current 
status of every component in the flow.",
             response = ProcessGroupStatusEntity.class,
             authorizations = {
                 @Authorization(value = "Read Only", type = "ROLE_MONITOR"),

http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/a297cd49/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/resources/templates/index.html.hbs
----------------------------------------------------------------------
diff --git 
a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/resources/templates/index.html.hbs
 
b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/resources/templates/index.html.hbs
index 18d5faf..c44a47f 100644
--- 
a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/resources/templates/index.html.hbs
+++ 
b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/resources/templates/index.html.hbs
@@ -476,7 +476,7 @@
         <div class="section">
             <div class="section-header">
                 <div class="title link">Process Groups</div>
-                <div class="sub-title section-description">Get the flow, 
Instantiate a template, Manage sub groups</div>
+                <div class="sub-title section-description">Get the flow, 
Instantiate a template, Manage sub groups, Monitor component status</div>
                 <div class="clear"></div>
             </div>
             <div id="process-group-endpoints" class="section-endpoints 
hidden"></div>

Reply via email to