nifi-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mcgil...@apache.org
Subject incubator-nifi git commit: NIFI-292: - Providing additional documentation for some endpoints. - Include allowable values.
Date Fri, 01 May 2015 18:25:09 GMT
Repository: incubator-nifi
Updated Branches:
  refs/heads/NIFI-292 ba2046480 -> 28c2f011f


NIFI-292:
- Providing additional documentation for some endpoints.
- Include allowable values.

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

Branch: refs/heads/NIFI-292
Commit: 28c2f011ff004c8932f9e85c02fd32c1220e35f4
Parents: ba20464
Author: Matt Gilman <matt.c.gilman@gmail.com>
Authored: Fri May 1 14:25:00 2015 -0400
Committer: Matt Gilman <matt.c.gilman@gmail.com>
Committed: Fri May 1 14:25:00 2015 -0400

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


http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/28c2f011/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/NodeResource.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/NodeResource.java
b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/NodeResource.java
index 60c858a..c88cc68 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/NodeResource.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/NodeResource.java
@@ -318,7 +318,7 @@ public class NodeResource extends ApplicationResource {
             )
             @PathParam("id") String id,
             @ApiParam(
-                    value = "The node configuration.",
+                    value = "The node configuration. The only configuration that will be
honored at this endpoint is the status or primary flag.",
                     required = true
             )
             NodeEntity nodeEntity) {

http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/28c2f011/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 e178714..a05b64a 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
@@ -643,7 +643,8 @@ public class ProcessGroupResource extends ApplicationResource {
     public Response updateProcessGroup(
             @Context HttpServletRequest httpServletRequest,
             @ApiParam(
-                    value = "The process group configuration details.",
+                    value = "The process group to update. The only action that is supported
at this endpoint is to set the running flag in order "
+                            + "to start or stop all descendent schedulable components. This
defines the schema of the expected input.",
                     required = true
             )
             ProcessGroupEntity processGroupEntity) {

http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/28c2f011/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 d40b5c8..18d5faf 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
@@ -183,6 +183,11 @@
                 color: #000;
             }
             
+            div.operation > table {
+                margin-left: 5px;
+                margin-right: 5px;
+            }
+            
             div.operation div.details {
                 margin-left: 5px;
                 margin-bottom: 5px;

http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/28c2f011/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/resources/templates/type.hbs
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/resources/templates/type.hbs
b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/resources/templates/type.hbs
index 925a8c8..d64610d 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/resources/templates/type.hbs
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/resources/templates/type.hbs
@@ -43,7 +43,7 @@
                         {{/ifeq}}
                     </td>
                     <td>{{#required}}required{{/required}}{{^required}}optional{{/required}}</td>
-                    <td>{{#description}}{{{description}}}{{/description}}</td>
+                    <td>{{#description}}{{{description}}}{{/description}}{{#if enum}}
Allowable values: {{join enum ", "}}{{/if}}</td>
                 </tr>
             {{/each}}
         </table>


Mime
View raw message