NIFI-10704 - include API name of properties in processor documentation

[greyp9]

Summary

NIFI-10704

Tracking

Please complete the following tracking steps prior to pull request creation.

Issue Tracking

• Apache NiFi Jira issue created

Pull Request Tracking

• Pull Request title starts with Apache NiFi Jira issue number, such as NIFI-00000
• Pull Request commit message starts with Apache NiFi Jira issue number, as such NIFI-00000

Pull Request Formatting

• Pull Request based on current revision of the main branch
• Pull Request refers to a feature branch with one commit containing changes

Verification

Please indicate the verification steps performed prior to pull request creation.

Build

• Build completed using mvn clean install -P contrib-check
  • JDK 8
  • JDK 11
  • JDK 17

Licensing

• New dependencies are compatible with the Apache License 2.0 according to the License Policy
• New dependencies are documented in applicable LICENSE and NOTICE files

Documentation

• Documentation formatting appears as expected in rendered files

[thenatog]

Will review

[mattyb149]

Since this is supposed to be a machine-friendly name, I wonder if we should put it as the last column so it doesn't make the user-friendly information "noisy". @andrewmlim Thoughts?

[andrewmlim]

@mattyb149 I understand the concern, but I think the way @greyp9 implemented is good. I think Display Name and API Name should be grouped together and since Description typically takes up a lot of space, the API Name column could get lost if placed as the last column.

[exceptionfactory]

@ottobackwards The REST API provides the information, but providing it in the generated documentation makes it more accessible when writing integrations. The internal property names are effectively final once released, so publishing them in the generated component documentation seems reasonable and useful.

[exceptionfactory]

+1 from my perspective, but I will defer to others for final review and approval.

[ottobackwards]

@exceptionfactory yeah, I was just thinking about the difference between developer documentation and UI/user documentation. What would be nice would be if there was a second additional details page that had the config dto as json and documented for developers, or that the rest api could provide a get_default_configuration for processors and controllers

[mattyb149]

+1 LGTM, appreciate the discussion! Thanks for the improvement, merging to main