Repository: incubator-nifi Updated Branches: refs/heads/NIFI-292 48625b73b -> 234b99b3c
NIFI-292: - Categorizing the endpoints. - Removing the package info previously used by enunciate. Project: http://git-wip-us.apache.org/repos/asf/incubator-nifi/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-nifi/commit/234b99b3 Tree: http://git-wip-us.apache.org/repos/asf/incubator-nifi/tree/234b99b3 Diff: http://git-wip-us.apache.org/repos/asf/incubator-nifi/diff/234b99b3 Branch: refs/heads/NIFI-292 Commit: 234b99b3ca3c8d53b0f8913097f96070ba312d46 Parents: 48625b7 Author: Matt Gilman <[email protected]> Authored: Fri May 1 09:39:30 2015 -0400 Committer: Matt Gilman <[email protected]> Committed: Fri May 1 09:39:30 2015 -0400 ---------------------------------------------------------------------- .../org/apache/nifi/web/api/package-info.java | 43 ------------ .../src/main/resources/templates/index.html.hbs | 70 +++++++++++--------- 2 files changed, 39 insertions(+), 74 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/234b99b3/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/package-info.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/package-info.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/package-info.java deleted file mode 100644 index 0392ca4..0000000 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/package-info.java +++ /dev/null @@ -1,43 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -/** - * <p> - * The NiFi REST API allows clients to obtain and update configuration and status information pertaining to an instance of NiFi. The links below detail each resource. Follow the link to get more - * information about the resource including the supported HTTP methods and the expected parameters.</p> - * - * <p> - * Additionally, the documentation for each resource will describe what type of data should be returned from a successful invocation. However, if the request is not successful one of the follow status - * codes should be returned:</p> - * - * <ul> - * <li>400 (Bad Request) - A 400 status code will be returned when NiFi is unable to complete the request because it was invalid. The request should not be retried without modification.</li> - * <li>401 (Unathorized) - A 401 status code indicates that the user is not known to this NiFi instance. The user may submit an account request.</li> - * <li>403 (Forbidden) - A 403 status code indicates that the user is known to this NiFi instance and they do not have authority to perform the requested action.</li> - * <li>404 (Not Found) - A 404 status code will be returned when the desired resource does not exist.</li> - * <li>409 (Conflict) - NiFi employs an optimistic locking strategy where the client must include a revision in their request when performing an update. If the specified revision does not match the - * current base revision a 409 status code is returned. Additionally, a 409 is used when the state of the system does not allow for the request at that time. This same request may be successful later - * if the system is in a different state (e.g. cannot delete a processor because it is currently running).</li> - * <li>500 (Internal Server Error) - A 500 status code indicates that an unexpected error has occurred.</li> - * </ul> - * - * <p> - * Most unsuccessful requests will include a description of the problem in the entity body of the response.</p> - * - * <p> - * The context path for the REST API is /nifi-api</p> - */ -package org.apache.nifi.web.api; http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/234b99b3/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 fa4c88d..c3775cc 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 @@ -238,6 +238,10 @@ background-color: #d1d1d1; } + div.section > div.title { + font-size: 24px; + } + div.section-endpoints { margin-top: 10px; } @@ -413,19 +417,19 @@ // organize the endpoints organizeEndpoints('cluster', $('#cluster-endpoints')); - organizeEndpoints('history', $('#history-endpoints')); organizeEndpoints('provenance', $('#provenance-endpoints')); organizeEndpoints('user', $('#user-endpoints')); - organizeEndpoints('controller-service', $('#controller-service-endpoints')); - organizeEndpoints('reporting-task', $('#reporting-task-endpoints')); + organizeEndpoints('controller-services', $('#controller-service-endpoints')); + organizeEndpoints('reporting-tasks', $('#reporting-task-endpoints')); organizeEndpoints('connections', $('#connection-endpoints')); organizeEndpoints('processors', $('#processor-endpoints')); organizeEndpoints('funnels', $('#funnel-endpoints')); + organizeEndpoints('remote-process-groups', $('#remote-process-group-endpoints')); organizeEndpoints('input-ports', $('#input-port-endpoints')); organizeEndpoints('output-ports', $('#output-port-endpoints')); - organizeEndpoints('remote-process-groups', $('#remote-process-group-endpoints')); organizeEndpoints('labels', $('#label-endpoints')); organizeEndpoints('process-groups', $('#process-group-endpoints')); + organizeEndpoints('history', $('#history-endpoints')); organizeEndpoints(null, $('#controller-endpoints')); @@ -446,38 +450,22 @@ <div class="clear"></div> <div class="overview">{{info.description}}</div> <div class="section"> - <div class="title link">Cluster</div> - <div id="cluster-endpoints" class="section-endpoints hidden"></div> - </div> - <div class="section"> - <div class="title link">History</div> - <div id="history-endpoints" class="section-endpoints hidden"></div> - </div> - <div class="section"> - <div class="title link">Provenance</div> - <div id="provenance-endpoints" class="section-endpoints hidden"></div> + <div class="title link">Controller</div> + <div id="controller-endpoints" class="section-endpoints hidden"></div> </div> <div class="section"> - <div class="title link">Users</div> - <div id="user-endpoints" class="section-endpoints hidden"></div> + <div class="title link">Process Groups</div> + <div id="process-group-endpoints" class="section-endpoints hidden"></div> </div> <div class="section"> - <div class="title link">Controller Services</div> - <div id="controller-service-endpoints" class="section-endpoints hidden"></div> + <div class="title link">Processors</div> + <div id="processor-endpoints" class="section-endpoints hidden"></div> </div> <div class="section"> <div class="title link">Connections</div> <div id="connection-endpoints" class="section-endpoints hidden"></div> </div> <div class="section"> - <div class="title link">Processors</div> - <div id="reporting-task-endpoints" class="section-endpoints hidden"></div> - </div> - <div class="section"> - <div class="title link">Funnels</div> - <div id="funnel-endpoints" class="section-endpoints hidden"></div> - </div> - <div class="section"> <div class="title link">Input Ports</div> <div id="input-port-endpoints" class="section-endpoints hidden"></div> </div> @@ -494,14 +482,34 @@ <div id="label-endpoints" class="section-endpoints hidden"></div> </div> <div class="section"> - <div class="title link">Process Groups</div> - <div id="process-group-endpoints" class="section-endpoints hidden"></div> + <div class="title link">Funnels</div> + <div id="funnel-endpoints" class="section-endpoints hidden"></div> </div> <div class="section"> - <div class="title link">Controller</div> - <div id="controller-endpoints" class="section-endpoints hidden"></div> + <div class="title link">Controller Services</div> + <div id="controller-service-endpoints" class="section-endpoints hidden"></div> + </div> + <div class="section"> + <div class="title link">Reporting Tasks</div> + <div id="reporting-task-endpoints" class="section-endpoints hidden"></div> + </div> + <div class="section"> + <div class="title link">Cluster</div> + <div id="cluster-endpoints" class="section-endpoints hidden"></div> + </div> + <div class="section"> + <div class="title link">Provenance</div> + <div id="provenance-endpoints" class="section-endpoints hidden"></div> + </div> + <div class="section"> + <div class="title link">History</div> + <div id="history-endpoints" class="section-endpoints hidden"></div> + </div> + <div class="section"> + <div class="title link">Users</div> + <div id="user-endpoints" class="section-endpoints hidden"></div> </div> - <div class="unorganized"> + <div class="unorganized hidden"> {{#each paths}} {{> endpoint}} {{/each}}
