This is an automated email from the ASF dual-hosted git repository.
exceptionfactory pushed a commit to branch main-staging
in repository https://gitbox.apache.org/repos/asf/nifi-site.git
The following commit(s) were added to refs/heads/main-staging by this push:
new 6fed3f2c NIFI-14221 Added REST API Version 2 Documentation
6fed3f2c is described below
commit 6fed3f2c6d105041deb18b3610ce3c9d0f787206
Author: exceptionfactory <[email protected]>
AuthorDate: Sat Feb 1 21:12:02 2025 -0600
NIFI-14221 Added REST API Version 2 Documentation
(cherry picked from commit a9c548c0cbc500fb33354704b67c70898de634c4)
---
prebuild.sh | 12 ++++++++++++
themes/nifi/layouts/section/components.html | 1 +
2 files changed, 13 insertions(+)
diff --git a/prebuild.sh b/prebuild.sh
index e25cfe5b..ece4a6c8 100644
--- a/prebuild.sh
+++ b/prebuild.sh
@@ -15,6 +15,11 @@ MANIFEST_DOCS_DIR=docs
NIFI_DOCS_ZIP_URL="$MAVEN_BASE_URL/org/apache/nifi/nifi-docs/$CURRENT_VERSION/nifi-docs-$CURRENT_VERSION-resources.zip"
NIFI_DOCS_ZIP_PATH=$RESOURCES_DIR/nifi-docs-resources.zip
+NIFI_WEB_API_WAR_URL="$MAVEN_BASE_URL/org/apache/nifi/nifi-web-api/$CURRENT_VERSION/nifi-web-api-$CURRENT_VERSION.war"
+NIFI_WEB_API_WAR_PATH=$RESOURCES_DIR/nifi-web-api.war
+REST_API_INDEX_HTML=docs/rest-api/index.html
+REST_API_SWAGGER_YAML=docs/rest-api/swagger.yaml
+
# Create Hugo directories
if [ ! -d $RESOURCES_DIR ];then
mkdir $RESOURCES_DIR
@@ -30,5 +35,12 @@ echo "Downloading $NIFI_DOCS_ZIP_URL"
curl -o $NIFI_DOCS_ZIP_PATH $NIFI_DOCS_ZIP_URL
unzip -q -o -d $PREBUILD_DIR/public $NIFI_DOCS_ZIP_PATH
+# Download REST API Documentation Resources and extract to prebuild
+echo "Downloading $NIFI_WEB_API_WAR_URL"
+curl -o $NIFI_WEB_API_WAR_PATH $NIFI_WEB_API_WAR_URL
+unzip -q -o -d $PREBUILD_DIR/public $NIFI_WEB_API_WAR_PATH
$REST_API_INDEX_HTML $REST_API_SWAGGER_YAML
+mv $PREBUILD_DIR/public/$REST_API_INDEX_HTML
$PREBUILD_DIR/public/html/rest-api.html
+mv $PREBUILD_DIR/public/$REST_API_SWAGGER_YAML
$PREBUILD_DIR/public/html/swagger.yaml
+
# Build components using prebuild directory with Hugo
hugo -s $PREBUILD_DIR
diff --git a/themes/nifi/layouts/section/components.html
b/themes/nifi/layouts/section/components.html
index e51b5b84..687d5e6a 100644
--- a/themes/nifi/layouts/section/components.html
+++ b/themes/nifi/layouts/section/components.html
@@ -30,6 +30,7 @@
<li><a href="{{ .Site.Params.staticDocsPath
}}/developer-guide.html">Developer Guide</a></li>
<li><a href="{{ .Site.Params.staticDocsPath
}}/python-developer-guide.html">Python Developer Guide</a></li>
<li><a href="{{ .Site.Params.staticDocsPath
}}/nifi-in-depth.html">Apache NiFi In Depth</a></li>
+ <li><a href="{{ .Site.Params.staticDocsPath
}}/rest-api.html">REST API</a></li>
</ul>
</div>
</li>
