You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nifi.apache.org by pv...@apache.org on 2021/04/27 10:23:48 UTC

[nifi] branch main updated: NIFI-8473 Added Parameter Contexts section to REST API documentation

This is an automated email from the ASF dual-hosted git repository.

pvillard pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/nifi.git


The following commit(s) were added to refs/heads/main by this push:
     new f9d3bb7  NIFI-8473 Added Parameter Contexts section to REST API documentation
f9d3bb7 is described below

commit f9d3bb7f697778ae35846af3927fa7df4dfefcf8
Author: exceptionfactory <ex...@apache.org>
AuthorDate: Mon Apr 26 11:15:33 2021 -0500

    NIFI-8473 Added Parameter Contexts section to REST API documentation
    
    Signed-off-by: Pierre Villard <pi...@gmail.com>
    
    This closes #5030.
---
 .../nifi-framework/nifi-web/nifi-web-api/pom.xml                 | 6 +++---
 .../nifi-web-api/src/main/resources/templates/index.html.hbs     | 9 +++++++++
 2 files changed, 12 insertions(+), 3 deletions(-)

diff --git a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/pom.xml b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/pom.xml
index d6b2971..f2e01dc 100644
--- a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/pom.xml
+++ b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/pom.xml
@@ -59,7 +59,7 @@
             <plugin>
                 <groupId>com.github.kongchen</groupId>
                 <artifactId>swagger-maven-plugin</artifactId>
-                <version>3.1.5</version>
+                <version>3.1.7</version>
                 <executions>
                     <execution>
                         <phase>compile</phase>
@@ -78,10 +78,10 @@
                                     </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 authorizations required
                                             to invoke each service.
diff --git a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/resources/templates/index.html.hbs b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/resources/templates/index.html.hbs
index 22c9f7a..4ce9d56 100644
--- a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/resources/templates/index.html.hbs
+++ b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/resources/templates/index.html.hbs
@@ -447,6 +447,7 @@
                 organizeEndpoints('/labels', $('#label-endpoints'));
                 organizeEndpoints('/access', $('#access-endpoints'));
                 organizeEndpoints('/flow', $('#flow-endpoints'));
+                organizeEndpoints('/parameter-contexts', $('#parameter-context-endpoints'));
                 organizeEndpoints('/provenance-events', $('#provenance-event-endpoints'));
                 organizeEndpoints('/provenance', $('#provenance-endpoints'));
                 organizeEndpoints('/tenants', $('#tenant-endpoints'));
@@ -526,6 +527,14 @@
         </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-header">
                 <div class="title link">Process Groups</div>
                 <div class="sub-title section-description">Create components, Instantiate a template, Upload a template</div>
                 <div class="clear"></div>