(nifi-api) branch NIFI-15258 updated: NIFI-15326: Adding support for connector configuration step documentation. (#28)

[markap14]

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

markap14 pushed a commit to branch NIFI-15258
in repository https://gitbox.apache.org/repos/asf/nifi-api.git


The following commit(s) were added to refs/heads/NIFI-15258 by this push:
     new 2a88f22  NIFI-15326: Adding support for connector configuration step 
documentation. (#28)
2a88f22 is described below

commit 2a88f2205efafc4f6dfd519b577da82097664f8f
Author: Matt Gilman <matt.c.gil...@gmail.com>
AuthorDate: Thu Dec 11 09:24:13 2025 -0500

    NIFI-15326: Adding support for connector configuration step documentation. 
(#28)
---
 .../nifi/components/connector/ConfigurationStep.java   | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git 
a/src/main/java/org/apache/nifi/components/connector/ConfigurationStep.java 
b/src/main/java/org/apache/nifi/components/connector/ConfigurationStep.java
index 6affd8e..585e74c 100644
--- a/src/main/java/org/apache/nifi/components/connector/ConfigurationStep.java
+++ b/src/main/java/org/apache/nifi/components/connector/ConfigurationStep.java
@@ -27,11 +27,13 @@ public final class ConfigurationStep {
     private final String name;
     private final String description;
     private final List<ConnectorPropertyGroup> propertyGroups;
+    private final String documentation;
 
     private ConfigurationStep(final Builder builder) {
         this.name = builder.name;
         this.description = builder.description;
         this.propertyGroups = 
Collections.unmodifiableList(builder.propertyGroups);
+        this.documentation = builder.documentation;
     }
 
     public String getName() {
@@ -46,11 +48,18 @@ public final class ConfigurationStep {
         return propertyGroups;
     }
 
+    /**
+     * @return the configuration step documentation in markdown
+     */
+    public String getDocumentation() {
+        return documentation;
+    }
 
     public static final class Builder {
         private String name;
         private String description;
         private List<ConnectorPropertyGroup> propertyGroups = 
Collections.emptyList();
+        private String documentation;
 
         public Builder name(String name) {
             this.name = name;
@@ -67,6 +76,15 @@ public final class ConfigurationStep {
             return this;
         }
 
+        /**
+         * @param documentation the documentation for this configuration step 
in markdown
+         * @return this builder
+         */
+        public Builder documentation(String documentation) {
+            this.documentation = documentation;
+            return this;
+        }
+
         public ConfigurationStep build() {
             if (name == null) {
                 throw new IllegalStateException("Configuration Step's name 
must be provided");