Apache
/
nifi
mirror of https://github.com/apache/nifi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

NIFI-1802 Separated /access REST API endpoints into separate section in API docs. 

Fixed typo in DocGenerator comments.

This closes #376.

Signed-off-by: Andy LoPresto <alopresto@apache.org>
This commit is contained in:
Andy LoPresto 2016-04-21 19:52:24 -07:00
parent 5314911314
commit 9ea2275677
No known key found for this signature in database
GPG Key ID: 3C6EF65B2F7DEF69
2 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-documentation/src/main/java/org/apache/nifi/documentation/DocGenerator.java
View File

@ -24,7 +24,6 @@ import java.io.IOException;
import java.io.OutputStream; import java.io.OutputStream;
import java.util.HashSet; import java.util.HashSet;
import java.util.Set; import java.util.Set;
import org.apache.nifi.components.ConfigurableComponent; import org.apache.nifi.components.ConfigurableComponent;
import org.apache.nifi.controller.ControllerService; import org.apache.nifi.controller.ControllerService;
import org.apache.nifi.documentation.html.HtmlDocumentationWriter; import org.apache.nifi.documentation.html.HtmlDocumentationWriter;
@ -82,7 +81,7 @@ public class DocGenerator {
} }
/** /**
* Generates the documentation for a particular configurable comopnent. Will * Generates the documentation for a particular configurable component. Will
* check to see if an "additionalDetails.html" file exists and will link * check to see if an "additionalDetails.html" file exists and will link
* that from the generated documentation. * that from the generated documentation.
* *

9
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/resources/templates/index.html.hbs
View File

@ -446,6 +446,7 @@
organizeEndpoints('labels', $('#label-endpoints')); organizeEndpoints('labels', $('#label-endpoints'));
organizeEndpoints('process-groups', $('#process-group-endpoints')); organizeEndpoints('process-groups', $('#process-group-endpoints'));
organizeEndpoints('history', $('#history-endpoints')); organizeEndpoints('history', $('#history-endpoints'));
organizeEndpoints('access', $('#access-endpoints'));
organizeEndpoints(null, $('#controller-endpoints')); organizeEndpoints(null, $('#controller-endpoints'));
@ -465,6 +466,14 @@
</div> </div>
<div class="clear"></div> <div class="clear"></div>
<div class="overview">{{info.description}}</div> <div class="overview">{{info.description}}</div>
<div class="section">
<div class="section-header">
<div class="title link">Access</div>
<div class="sub-title section-description">User authentication and token endpoints</div>
<div class="clear"></div>
</div>
<div id="access-endpoints" class="section-endpoints hidden"></div>
</div>
<div class="section"> <div class="section">
<div class="section-header"> <div class="section-header">
<div class="title link">Controller</div> <div class="title link">Controller</div>