[GitHub] nifi-minifi-cpp pull request #457: MINIFICPP-691: Add method for getting pro...
Github user asfgit closed the pull request at: https://github.com/apache/nifi-minifi-cpp/pull/457 ---
[GitHub] nifi-minifi-cpp pull request #457: MINIFICPP-691: Add method for getting pro...
Github user phrocker commented on a diff in the pull request:
https://github.com/apache/nifi-minifi-cpp/pull/457#discussion_r239819770
--- Diff: extensions/mqtt/processors/PublishMQTT.h ---
@@ -137,7 +137,7 @@ class PublishMQTT : public
processors::AbstractMQTTProcessor {
std::shared_ptr logger_;
};
-REGISTER_RESOURCE(PublishMQTT);
+REGISTER_RESOURCE(PublishMQTT, "This Processor puts the contents of a
FlowFile to a MQTT broker for a specified topic. The content of a FlowFile
becomes the payload of the MQTT message.");
--- End diff --
Hmm that's a good point. I'll see if I can clarify this, then.
---
[GitHub] nifi-minifi-cpp pull request #457: MINIFICPP-691: Add method for getting pro...
Github user arpadboda commented on a diff in the pull request:
https://github.com/apache/nifi-minifi-cpp/pull/457#discussion_r239815939
--- Diff: extensions/mqtt/processors/PublishMQTT.h ---
@@ -137,7 +137,7 @@ class PublishMQTT : public
processors::AbstractMQTTProcessor {
std::shared_ptr logger_;
};
-REGISTER_RESOURCE(PublishMQTT);
+REGISTER_RESOURCE(PublishMQTT, "This Processor puts the contents of a
FlowFile to a MQTT broker for a specified topic. The content of a FlowFile
becomes the payload of the MQTT message.");
--- End diff --
Naturally I'm not a native speaker, the reason I asked is having both
plural and singular usage of content when it's about a single flow file.
---
[GitHub] nifi-minifi-cpp pull request #457: MINIFICPP-691: Add method for getting pro...
Github user phrocker commented on a diff in the pull request: https://github.com/apache/nifi-minifi-cpp/pull/457#discussion_r239815707 --- Diff: libminifi/include/processors/GetFile.h --- @@ -194,7 +194,7 @@ class GetFile : public core::Processor, public state::response::MetricsNodeSourc std::shared_ptr logger_; }; -REGISTER_RESOURCE(GetFile); +REGISTER_RESOURCE(GetFile,"Creates FlowFiles from files in a directory. NiFi will ignore files for which it doesn't have read permissions."); --- End diff -- ha actually this one I modified as it ended in a prepositional phrase but I didn't notice the NiFi. Thanks! ---
[GitHub] nifi-minifi-cpp pull request #457: MINIFICPP-691: Add method for getting pro...
Github user phrocker commented on a diff in the pull request:
https://github.com/apache/nifi-minifi-cpp/pull/457#discussion_r239815379
--- Diff: extensions/mqtt/processors/PublishMQTT.h ---
@@ -137,7 +137,7 @@ class PublishMQTT : public
processors::AbstractMQTTProcessor {
std::shared_ptr logger_;
};
-REGISTER_RESOURCE(PublishMQTT);
+REGISTER_RESOURCE(PublishMQTT, "This Processor puts the contents of a
FlowFile to a MQTT broker for a specified topic. The content of a FlowFile
becomes the payload of the MQTT message.");
--- End diff --
In plural form contents can referenced in a concrete sense to things
contained within something. This isn't incorrect. I'll err on avoiding to
change the original author's wording.
---
[GitHub] nifi-minifi-cpp pull request #457: MINIFICPP-691: Add method for getting pro...
Github user phrocker commented on a diff in the pull request:
https://github.com/apache/nifi-minifi-cpp/pull/457#discussion_r239814559
--- Diff: extensions/libarchive/MergeContent.h ---
@@ -334,7 +334,9 @@ class MergeContent : public processors::BinFiles {
std::string readContent(std::string path);
};
-REGISTER_RESOURCE(MergeContent);
+REGISTER_RESOURCE(MergeContent, "Merges a Group of FlowFiles together
based on a user-defined strategy and packages them into a single FlowFile. "
+"It is recommended that the Processor be configured with only a single
incoming connection, as Group of FlowFiles will not be created from "
--- End diff --
"Processor is configured" would be passive voice, so not the best choice if
we are to nit.
---
[GitHub] nifi-minifi-cpp pull request #457: MINIFICPP-691: Add method for getting pro...
Github user phrocker commented on a diff in the pull request:
https://github.com/apache/nifi-minifi-cpp/pull/457#discussion_r239792561
--- Diff: extensions/mqtt/processors/AbstractMQTTProcessor.h ---
@@ -157,7 +157,6 @@ class AbstractMQTTProcessor : public core::Processor {
std::string securityPrivateKeyPassWord_;
};
-REGISTER_RESOURCE(AbstractMQTTProcessor);
--- End diff --
The appropriate thing would be to remove this class, actually. I'll try to
put the details in a ticket, but the priority is low since it's an extension
---
[GitHub] nifi-minifi-cpp pull request #457: MINIFICPP-691: Add method for getting pro...
Github user phrocker commented on a diff in the pull request: https://github.com/apache/nifi-minifi-cpp/pull/457#discussion_r239792102 --- Diff: libminifi/include/processors/GetFile.h --- @@ -194,7 +194,7 @@ class GetFile : public core::Processor, public state::response::MetricsNodeSourc std::shared_ptr logger_; }; -REGISTER_RESOURCE(GetFile); +REGISTER_RESOURCE(GetFile,"Creates FlowFiles from files in a directory. NiFi will ignore files for which it doesn't have read permissions."); --- End diff -- Yah. These are auto copied from processors.md, so these typos exist there too. Thank for catching. ---
[GitHub] nifi-minifi-cpp pull request #457: MINIFICPP-691: Add method for getting pro...
Github user arpadboda commented on a diff in the pull request: https://github.com/apache/nifi-minifi-cpp/pull/457#discussion_r239780670 --- Diff: libminifi/include/processors/GetFile.h --- @@ -194,7 +194,7 @@ class GetFile : public core::Processor, public state::response::MetricsNodeSourc std::shared_ptr logger_; }; -REGISTER_RESOURCE(GetFile); +REGISTER_RESOURCE(GetFile,"Creates FlowFiles from files in a directory. NiFi will ignore files for which it doesn't have read permissions."); --- End diff -- MiNiFi? ---
[GitHub] nifi-minifi-cpp pull request #457: MINIFICPP-691: Add method for getting pro...
Github user arpadboda commented on a diff in the pull request:
https://github.com/apache/nifi-minifi-cpp/pull/457#discussion_r239778574
--- Diff: extensions/mqtt/processors/PublishMQTT.h ---
@@ -137,7 +137,7 @@ class PublishMQTT : public
processors::AbstractMQTTProcessor {
std::shared_ptr logger_;
};
-REGISTER_RESOURCE(PublishMQTT);
+REGISTER_RESOURCE(PublishMQTT, "This Processor puts the contents of a
FlowFile to a MQTT broker for a specified topic. The content of a FlowFile
becomes the payload of the MQTT message.");
--- End diff --
```
contents of a FlowFile
```
content?
---
[GitHub] nifi-minifi-cpp pull request #457: MINIFICPP-691: Add method for getting pro...
Github user arpadboda commented on a diff in the pull request:
https://github.com/apache/nifi-minifi-cpp/pull/457#discussion_r239776939
--- Diff: extensions/mqtt/processors/AbstractMQTTProcessor.h ---
@@ -157,7 +157,6 @@ class AbstractMQTTProcessor : public core::Processor {
std::string securityPrivateKeyPassWord_;
};
-REGISTER_RESOURCE(AbstractMQTTProcessor);
--- End diff --
Good spot, however could you make the class abstact, too?
(REGISTER_RESOURCE fails to compile in case the argument is abstact class, so
it makes sure it doesn't happen again)
I'm also wondering whet making "Processor" abstact would make sense or not.
If you create a follow-up Jira, I can do as well.
---
[GitHub] nifi-minifi-cpp pull request #457: MINIFICPP-691: Add method for getting pro...
Github user arpadboda commented on a diff in the pull request:
https://github.com/apache/nifi-minifi-cpp/pull/457#discussion_r239771411
--- Diff: extensions/libarchive/MergeContent.h ---
@@ -334,7 +334,9 @@ class MergeContent : public processors::BinFiles {
std::string readContent(std::string path);
};
-REGISTER_RESOURCE(MergeContent);
+REGISTER_RESOURCE(MergeContent, "Merges a Group of FlowFiles together
based on a user-defined strategy and packages them into a single FlowFile. "
+"It is recommended that the Processor be configured with only a single
incoming connection, as Group of FlowFiles will not be created from "
--- End diff --
Processor is configured?
---
[GitHub] nifi-minifi-cpp pull request #457: MINIFICPP-691: Add method for getting pro...
GitHub user phrocker opened a pull request: https://github.com/apache/nifi-minifi-cpp/pull/457 MINIFICPP-691: Add method for getting processor description. Internal⦠⦠API change, but is strictly voluntary for contributors Based on work from September -- enables us to get a better documentation picture in agent information. Will allow us to eventually auto generate some docs. While this is an internal API call we still don't want to fully break anyone, so I've updated every usage of it in our code base. Further, this is purely optional function to be used, so the risk of making a change to it is minimal. Thank you for submitting a contribution to Apache NiFi - MiNiFi C++. In order to streamline the review of the contribution we ask you to ensure the following steps have been taken: ### For all changes: - [ ] Is there a JIRA ticket associated with this PR? Is it referenced in the commit message? - [ ] Does your PR title start with MINIFICPP- where is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character. - [ ] Has your PR been rebased against the latest commit within the target branch (typically master)? - [ ] Is your initial contribution a single, squashed commit? ### For code changes: - [ ] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under [ASF 2.0](http://www.apache.org/legal/resolved.html#category-a)? - [ ] If applicable, have you updated the LICENSE file? - [ ] If applicable, have you updated the NOTICE file? ### For documentation related changes: - [ ] Have you ensured that format looks appropriate for the output in which it is rendered? ### Note: Please ensure that once the PR is submitted, you check travis-ci for build issues and submit an update to your PR as soon as possible. You can merge this pull request into a Git repository by running: $ git pull https://github.com/phrocker/nifi-minifi-cpp MINIFICPP-691 Alternatively you can review and apply these changes as the patch at: https://github.com/apache/nifi-minifi-cpp/pull/457.patch To close this pull request, make a commit to your master/trunk branch with (at least) the following in the commit message: This closes #457 commit c3bcc1e4ec1a5665d3615fd55869fdaf9ebed53c Author: Marc Parisi Date: 2018-12-06T12:25:37Z MINIFICPP-691: Add method for getting processor description. Internal API change, but is strictly voluntary for contributors ---
