Repository: incubator-nifi Updated Branches: refs/heads/NIFI-292 0da9716cb -> b5fedbafe
NIFI-292: - Adding examples to annotate the categories of endpoints. Project: http://git-wip-us.apache.org/repos/asf/incubator-nifi/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-nifi/commit/b5fedbaf Tree: http://git-wip-us.apache.org/repos/asf/incubator-nifi/tree/b5fedbaf Diff: http://git-wip-us.apache.org/repos/asf/incubator-nifi/diff/b5fedbaf Branch: refs/heads/NIFI-292 Commit: b5fedbafe23013109486132cf1d09900f3a5515e Parents: 0da9716 Author: Matt Gilman <[email protected]> Authored: Fri May 1 12:44:52 2015 -0400 Committer: Matt Gilman <[email protected]> Committed: Fri May 1 12:44:52 2015 -0400 ---------------------------------------------------------------------- .../nifi-web/nifi-web-api/pom.xml | 4 +- .../src/main/resources/templates/index.html.hbs | 105 +++++++++++++++---- 2 files changed, 88 insertions(+), 21 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/b5fedbaf/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/pom.xml ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/pom.xml b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/pom.xml index 20afb61..16084ba 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/pom.xml +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/pom.xml @@ -56,10 +56,10 @@ <schemes>http,https</schemes> <basePath>/nifi-api</basePath> <info> - <title>NiFi Rest Api</title> + <title>NiFi REST API</title> <version>${project.version}</version> <description> - The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and + The REST API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorities required to invoke each service. http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/b5fedbaf/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 9973c10..2fff0db 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 @@ -58,12 +58,13 @@ line-height: 50px; } - div.sub-title { + .sub-title { font-style: italic; color: #aaa; } div.overview { + margin-top: 10px; margin-bottom: 15px; } @@ -242,8 +243,14 @@ background-color: #d1d1d1; } - div.section > div.title { + div.section-header > div.title { font-size: 24px; + float: left; + } + + div.section-description { + float: right; + margin-top: 10px; } div.section-endpoints { @@ -438,8 +445,8 @@ // handle expanding/collapsing the sections - $('div.section > div.title').on('click', function() { - $(this).next('div.section-endpoints').slideToggle(); + $('div.section-header > div.title').on('click', function() { + $(this).parent('div.section-header').next('div.section-endpoints').slideToggle(); }); }); </script> @@ -454,63 +461,123 @@ <div class="clear"></div> <div class="overview">{{info.description}}</div> <div class="section"> - <div class="title link">Controller</div> + <div class="section-header"> + <div class="title link">Controller</div> + <div class="sub-title section-description">Get controller configuration, Search the flow, Manage templates, System diagnostics</div> + <div class="clear"></div> + </div> <div id="controller-endpoints" class="section-endpoints hidden"></div> </div> <div class="section"> - <div class="title link">Process Groups</div> + <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="clear"></div> + </div> <div id="process-group-endpoints" class="section-endpoints hidden"></div> </div> <div class="section"> - <div class="title link">Processors</div> + <div class="section-header"> + <div class="title link">Processors</div> + <div class="sub-title section-description">Create a processor, Set properties, Schedule</div> + <div class="clear"></div> + </div> <div id="processor-endpoints" class="section-endpoints hidden"></div> </div> <div class="section"> - <div class="title link">Connections</div> + <div class="section-header"> + <div class="title link">Connections</div> + <div class="sub-title section-description">Create a connection, Set queue prioritizer, Update connection destination</div> + <div class="clear"></div> + </div> <div id="connection-endpoints" class="section-endpoints hidden"></div> </div> <div class="section"> - <div class="title link">Input Ports</div> + <div class="section-header"> + <div class="title link">Input Ports</div> + <div class="sub-title section-description">Create an input port, Set remote port access control</div> + <div class="clear"></div> + </div> <div id="input-port-endpoints" class="section-endpoints hidden"></div> </div> <div class="section"> - <div class="title link">Output Ports</div> + <div class="section-header"> + <div class="title link">Output Ports</div> + <div class="sub-title section-description">Create an output port, Set remote port access control</div> + <div class="clear"></div> + </div> <div id="output-port-endpoints" class="section-endpoints hidden"></div> </div> <div class="section"> - <div class="title link">Remote Process Groups</div> + <div class="section-header"> + <div class="title link">Remote Process Groups</div> + <div class="sub-title section-description">Create a remote group, Enable transmission</div> + <div class="clear"></div> + </div> <div id="remote-process-group-endpoints" class="section-endpoints hidden"></div> </div> <div class="section"> - <div class="title link">Labels</div> + <div class="section-header"> + <div class="title link">Labels</div> + <div class="sub-title section-description">Create a label, Set label style</div> + <div class="clear"></div> + </div> <div id="label-endpoints" class="section-endpoints hidden"></div> </div> <div class="section"> - <div class="title link">Funnels</div> + <div class="section-header"> + <div class="title link">Funnels</div> + <div class="sub-title section-description">Manage funnels</div> + <div class="clear"></div> + </div> <div id="funnel-endpoints" class="section-endpoints hidden"></div> </div> <div class="section"> - <div class="title link">Controller Services</div> + <div class="section-header"> + <div class="title link">Controller Services</div> + <div class="sub-title section-description">Manage controller services, Update controller service references</div> + <div class="clear"></div> + </div> <div id="controller-service-endpoints" class="section-endpoints hidden"></div> </div> <div class="section"> - <div class="title link">Reporting Tasks</div> + <div class="section-header"> + <div class="title link">Reporting Tasks</div> + <div class="sub-title section-description">Manage reporting tasks</div> + <div class="clear"></div> + </div> <div id="reporting-task-endpoints" class="section-endpoints hidden"></div> </div> <div class="section"> - <div class="title link">Cluster</div> + <div class="section-header"> + <div class="title link">Cluster</div> + <div class="sub-title section-description">View node status, Disconnect nodes, Aggregate component status</div> + <div class="clear"></div> + </div> <div id="cluster-endpoints" class="section-endpoints hidden"></div> </div> <div class="section"> - <div class="title link">Provenance</div> + <div class="section-header"> + <div class="title link">Provenance</div> + <div class="sub-title section-description">Query provenance, Search event lineage, Download content, Replay</div> + <div class="clear"></div> + </div> <div id="provenance-endpoints" class="section-endpoints hidden"></div> </div> <div class="section"> - <div class="title link">History</div> + <div class="section-header"> + <div class="title link">History</div> + <div class="sub-title section-description">View flow history, Purge flow history</div> + <div class="clear"></div> + </div> <div id="history-endpoints" class="section-endpoints hidden"></div> </div> <div class="section"> - <div class="title link">Users</div> + <div class="section-header"> + <div class="title link">Users</div> + <div class="sub-title section-description">Update user access, revoke accounts, get account details, Group users</div> + <div class="clear"></div> + </div> <div id="user-endpoints" class="section-endpoints hidden"></div> </div> <div class="unorganized hidden">
