Uploaded image for project: 'Apache NiFi'
  1. Apache NiFi
  2. NIFI-3799

Document and / or visually show if a procesor accepts "input" connection

    Details

    • Type: New Feature
    • Status: Patch Available
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None

      Description

      Today the only way of knowing if a processor accepts input connection is either by trying it on the UI or looking at the processor code.

      @InputRequirement(Requirement.INPUT_FORBIDDEN)
      or
      @InputRequirement(Requirement.INPUT_REQUIRED)

      It would help a DFM if there is at least some documentation on this either under usage link or a tag .... to have alternative ways of knowing proactively.

        Issue Links

          Activity

          Hide
          githubbot ASF GitHub Bot added a comment -

          GitHub user pvillard31 opened a pull request:

          https://github.com/apache/nifi/pull/1756

          NIFI-3799 - added input requirement info for processor documentation

          Thank you for submitting a contribution to Apache NiFi.

          In order to streamline the review of the contribution we ask you
          to ensure the following steps have been taken:

              1. For all changes:
          • [X] Is there a JIRA ticket associated with this PR? Is it referenced
            in the commit message?
          • [X] Does your PR title start with NIFI-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.
          • [X] Has your PR been rebased against the latest commit within the target branch (typically master)?
          • [X] Is your initial contribution a single, squashed commit?
              1. For code changes:
          • [X] Have you ensured that the full suite of tests is executed via mvn -Pcontrib-check clean install at the root nifi folder?
          • [X] Have you written or updated unit tests to verify your changes?
              1. For documentation related changes:
          • [X] Have you ensured that format looks appropriate for the output in which it is rendered?
              1. 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/pvillard31/nifi NIFI-3799

          Alternatively you can review and apply these changes as the patch at:

          https://github.com/apache/nifi/pull/1756.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 #1756


          commit d9e1ec572cea40a35efde60f9dff82fccfc41e43
          Author: Pierre Villard <pierre.villard.fr@gmail.com>
          Date: 2017-05-05T13:05:02Z

          NIFI-3799 - added input requirement info for processor documentation


          Show
          githubbot ASF GitHub Bot added a comment - GitHub user pvillard31 opened a pull request: https://github.com/apache/nifi/pull/1756 NIFI-3799 - added input requirement info for processor documentation Thank you for submitting a contribution to Apache NiFi. In order to streamline the review of the contribution we ask you to ensure the following steps have been taken: For all changes: [X] Is there a JIRA ticket associated with this PR? Is it referenced in the commit message? [X] Does your PR title start with NIFI-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character. [X] Has your PR been rebased against the latest commit within the target branch (typically master)? [X] Is your initial contribution a single, squashed commit? For code changes: [X] Have you ensured that the full suite of tests is executed via mvn -Pcontrib-check clean install at the root nifi folder? [X] Have you written or updated unit tests to verify your changes? For documentation related changes: [X] 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/pvillard31/nifi NIFI-3799 Alternatively you can review and apply these changes as the patch at: https://github.com/apache/nifi/pull/1756.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 #1756 commit d9e1ec572cea40a35efde60f9dff82fccfc41e43 Author: Pierre Villard <pierre.villard.fr@gmail.com> Date: 2017-05-05T13:05:02Z NIFI-3799 - added input requirement info for processor documentation
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user jvwing commented on the issue:

          https://github.com/apache/nifi/pull/1756

          Reviewing...

          Show
          githubbot ASF GitHub Bot added a comment - Github user jvwing commented on the issue: https://github.com/apache/nifi/pull/1756 Reviewing...
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user jvwing commented on the issue:

          https://github.com/apache/nifi/pull/1756

          @pvillard31 - Everything works well in my testing. Why add the notation to the bottom of the Description section, rather than creating a new section with heading? For example, the Restricted section seems comparable, but it has a heading and then the text describing the restriction under the heading.

          Show
          githubbot ASF GitHub Bot added a comment - Github user jvwing commented on the issue: https://github.com/apache/nifi/pull/1756 @pvillard31 - Everything works well in my testing. Why add the notation to the bottom of the Description section, rather than creating a new section with heading? For example, the Restricted section seems comparable, but it has a heading and then the text describing the restriction under the heading.
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user pvillard31 commented on the issue:

          https://github.com/apache/nifi/pull/1756

          Hey @jvwing! Thanks for the review, you're right following the same "style" is more consistent. I updated the PR to follow the same approach as for restricted components.

          Show
          githubbot ASF GitHub Bot added a comment - Github user pvillard31 commented on the issue: https://github.com/apache/nifi/pull/1756 Hey @jvwing! Thanks for the review, you're right following the same "style" is more consistent. I updated the PR to follow the same approach as for restricted components.
          Hide
          jira-bot ASF subversion and git services added a comment -

          Commit fb7d6d1150bfa4338b31e73c244d039f57819c94 in nifi's branch refs/heads/master from Pierre Villard
          [ https://git-wip-us.apache.org/repos/asf?p=nifi.git;h=fb7d6d1 ]

          NIFI-3799 Add Input Requirement Info to Docs

          Added input requirement info for processor documentation

          This closes #1756.

          Signed-off-by: James Wing <jvwing@gmail.com>

          Show
          jira-bot ASF subversion and git services added a comment - Commit fb7d6d1150bfa4338b31e73c244d039f57819c94 in nifi's branch refs/heads/master from Pierre Villard [ https://git-wip-us.apache.org/repos/asf?p=nifi.git;h=fb7d6d1 ] NIFI-3799 Add Input Requirement Info to Docs Added input requirement info for processor documentation This closes #1756. Signed-off-by: James Wing <jvwing@gmail.com>
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user asfgit closed the pull request at:

          https://github.com/apache/nifi/pull/1756

          Show
          githubbot ASF GitHub Bot added a comment - Github user asfgit closed the pull request at: https://github.com/apache/nifi/pull/1756
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user jvwing commented on the issue:

          https://github.com/apache/nifi/pull/1756

          Thanks for that change, @pvillard31, it looks good.

          Show
          githubbot ASF GitHub Bot added a comment - Github user jvwing commented on the issue: https://github.com/apache/nifi/pull/1756 Thanks for that change, @pvillard31, it looks good.
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user pvillard31 commented on the issue:

          https://github.com/apache/nifi/pull/1756

          Thanks @jvwing

          Show
          githubbot ASF GitHub Bot added a comment - Github user pvillard31 commented on the issue: https://github.com/apache/nifi/pull/1756 Thanks @jvwing

            People

            • Assignee:
              pvillard Pierre Villard
              Reporter:
              digitalplumber Juan C. Sequeiros
            • Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

              • Created:
                Updated:

                Development