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

NIFI-8473 Added Parameter Contexts section to REST API documentation 

Signed-off-by: Pierre Villard <pierre.villard.fr@gmail.com>

This closes #5030.
This commit is contained in:
exceptionfactory 2021-04-26 11:15:33 -05:00 committed by Pierre Villard
parent 835f50c83a
commit f9d3bb7f69
No known key found for this signature in database
GPG Key ID: F92A93B30C07C6D5
2 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/pom.xml
View File

@ -59,7 +59,7 @@
<plugin> <plugin>
<groupId>com.github.kongchen</groupId> <groupId>com.github.kongchen</groupId>
<artifactId>swagger-maven-plugin</artifactId> <artifactId>swagger-maven-plugin</artifactId>
<version>3.1.5</version> <version>3.1.7</version>
<executions> <executions>
<execution> <execution>
<phase>compile</phase> <phase>compile</phase>
@ -78,10 +78,10 @@
</schemes> </schemes>
<basePath>/nifi-api</basePath> <basePath>/nifi-api</basePath>
<info> <info>
<title>NiFi Rest Api</title> <title>NiFi Rest API</title>
<version>${project.version}</version> <version>${project.version}</version>
<description> <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, 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 authorizations required definitions of the expected input and output, potential response codes, and the authorizations required
to invoke each service. to invoke each service.

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

@ -447,6 +447,7 @@
organizeEndpoints('/labels', $('#label-endpoints')); organizeEndpoints('/labels', $('#label-endpoints'));
organizeEndpoints('/access', $('#access-endpoints')); organizeEndpoints('/access', $('#access-endpoints'));
organizeEndpoints('/flow', $('#flow-endpoints')); organizeEndpoints('/flow', $('#flow-endpoints'));
organizeEndpoints('/parameter-contexts', $('#parameter-context-endpoints'));
organizeEndpoints('/provenance-events', $('#provenance-event-endpoints')); organizeEndpoints('/provenance-events', $('#provenance-event-endpoints'));
organizeEndpoints('/provenance', $('#provenance-endpoints')); organizeEndpoints('/provenance', $('#provenance-endpoints'));
organizeEndpoints('/tenants', $('#tenant-endpoints')); organizeEndpoints('/tenants', $('#tenant-endpoints'));
@ -524,6 +525,14 @@
</div> </div>
<div id="flow-endpoints" class="section-endpoints hidden"></div> <div id="flow-endpoints" class="section-endpoints hidden"></div>
</div> </div>
<div class="section">
<div class="section-header">
<div class="title link">Parameter Contexts</div>
<div class="sub-title section-description">Manage Parameter Contexts and associated validation</div>
<div class="clear"></div>
</div>
<div id="parameter-context-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">Process Groups</div> <div class="title link">Process Groups</div>