[jira] [Commented] (NIFI-1795) Improve documentation regarding PropertyDescriptor name & displayName

["Ryan Withers (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/NIFI-1795?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16775477#comment-16775477 ] 

Ryan Withers commented on NIFI-1795:
------------------------------------

[~alopresto] I am going to assign this issue to myself as you recommended.  Seems like there are two places that this documentation would have to be updated.  PropertyDescriptor and PropertyDescriptorDTO where PropertyDescriptor is javadoc and the PropertyDescriptorDTO contains the annotations that would render the swagger documentation.  Is it a safe assumption to consider the audience of both of these entries is developers?  

I see some uses of the PropertyDescriptor object in the aws and gcp bundles from what I see those seem to be use cases of PropertyDescriptor. 

I'm going to use this ticket to walk thought the whole lifecycle of a contribution.  Thanks for pointing it out to me.  Seems pretty straight forward, let me know if I've missed anything. 

> Improve documentation regarding PropertyDescriptor name & displayName
> ---------------------------------------------------------------------
>
>                 Key: NIFI-1795
>                 URL: https://issues.apache.org/jira/browse/NIFI-1795
>             Project: Apache NiFi
>          Issue Type: Improvement
>          Components: Documentation & Website
>    Affects Versions: 0.6.1
>            Reporter: Andy LoPresto
>            Assignee: Andy LoPresto
>            Priority: Minor
>
> As evidenced in numerous pull requests, developers are often unaware of the behavior of {{PropertyDescriptor}} {{name}} and {{displayName}} attributes. Originally, {{name}} existed and served as both the UI display value for the processor properties configuration dialog and as the unique identifier when writing/reading the properties from file storage. However, a change to the {{name}} value after the flow had been persisted could cause issues retrieving the value from file storage. Thus, {{displayName}} was introduced as the UI display value to allow for backward-compatible updates. The documentation does not sufficiently explain this information and can better encourage developers to provide both {{name}} and {{displayName}} attributes in order to be proactive on flow compatibility and to improve the foundation for internationalization and localization of the UI. 



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)