[jira] [Created] (NIFI-1290) Document the need for an explicit Validator for a PropertyDescriptor

["Matt Burgess (JIRA)" <ji...@apache.org>]

Matt Burgess created NIFI-1290:
----------------------------------

             Summary: Document the need for an explicit Validator for a PropertyDescriptor
                 Key: NIFI-1290
                 URL: https://issues.apache.org/jira/browse/NIFI-1290
             Project: Apache NiFi
          Issue Type: Improvement
          Components: Documentation & Website
            Reporter: Matt Burgess


If a PropertyDescriptor (for a Processor) does not explicitly define a Validator, it is assumed invalid. This is ensure the developer knows that custom validation is necessary for added properties.

The current doc (as of 0.4.0) says the following:
--------------------------------------------------------------
A PropertyDescriptor may specify one or more Validators that can be
used to ensure that the user-entered value
for a property is valid. If a Validator indicates that a property
value is invalid, the Component will not be
able to be run or used until the property becomes valid.
--------------------------------------------------------------

Propose the following:
--------------------------------------------------------------
A PropertyDescriptor MUST specify one or more Validators that can be
used to ensure that the user-entered value
for a property is valid. If a Validator indicates that a property
value is invalid, the Component will not be
able to be run or used until the property becomes valid. If you do not 
specify a Validator, the Component will be assumed invalid and NiFi
will report that the property is not supported.
--------------------------------------------------------------



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)