You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@nifi.apache.org by GitBox <gi...@apache.org> on 2022/10/27 00:30:15 UTC
[GitHub] [nifi] greyp9 opened a new pull request, #6586: NIFI-10704 - include API name of properties in processor documentation
greyp9 opened a new pull request, #6586:
URL: https://github.com/apache/nifi/pull/6586
# Summary
[NIFI-10704](https://issues.apache.org/jira/browse/NIFI-10704)
# Tracking
Please complete the following tracking steps prior to pull request creation.
### Issue Tracking
- [x] [Apache NiFi Jira](https://issues.apache.org/jira/browse/NIFI) issue created
### Pull Request Tracking
- [x] Pull Request title starts with Apache NiFi Jira issue number, such as `NIFI-00000`
- [x] Pull Request commit message starts with Apache NiFi Jira issue number, as such `NIFI-00000`
### Pull Request Formatting
- [x] Pull Request based on current revision of the `main` branch
- [x] 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](https://apache.org/licenses/LICENSE-2.0) according to the [License Policy](https://www.apache.org/legal/resolved.html)
- [ ] New dependencies are documented in applicable `LICENSE` and `NOTICE` files
### Documentation
- [x] Documentation formatting appears as expected in rendered files
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] thenatog commented on pull request #6586: NIFI-10704 - include API name of properties in processor documentation
Posted by GitBox <gi...@apache.org>.
thenatog commented on PR #6586:
URL: https://github.com/apache/nifi/pull/6586#issuecomment-1293802600
Will review
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] ottobackwards commented on pull request #6586: NIFI-10704 - include API name of properties in processor documentation
Posted by GitBox <gi...@apache.org>.
ottobackwards commented on PR #6586:
URL: https://github.com/apache/nifi/pull/6586#issuecomment-1295006294
@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
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] ottobackwards commented on pull request #6586: NIFI-10704 - include API name of properties in processor documentation
Posted by GitBox <gi...@apache.org>.
ottobackwards commented on PR #6586:
URL: https://github.com/apache/nifi/pull/6586#issuecomment-1294295350
Wouldn't the real fix be to have both names available through the rest api?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] mattyb149 commented on pull request #6586: NIFI-10704 - include API name of properties in processor documentation
Posted by GitBox <gi...@apache.org>.
mattyb149 commented on PR #6586:
URL: https://github.com/apache/nifi/pull/6586#issuecomment-1295311000
+1 LGTM, appreciate the discussion! Thanks for the improvement, merging to main
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] exceptionfactory commented on pull request #6586: NIFI-10704 - include API name of properties in processor documentation
Posted by GitBox <gi...@apache.org>.
exceptionfactory commented on PR #6586:
URL: https://github.com/apache/nifi/pull/6586#issuecomment-1294309477
@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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] andrewmlim commented on pull request #6586: NIFI-10704 - include API name of properties in processor documentation
Posted by GitBox <gi...@apache.org>.
andrewmlim commented on PR #6586:
URL: https://github.com/apache/nifi/pull/6586#issuecomment-1293965730
@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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] mattyb149 closed pull request #6586: NIFI-10704 - include API name of properties in processor documentation
Posted by GitBox <gi...@apache.org>.
mattyb149 closed pull request #6586: NIFI-10704 - include API name of properties in processor documentation
URL: https://github.com/apache/nifi/pull/6586
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] mattyb149 commented on pull request #6586: NIFI-10704 - include API name of properties in processor documentation
Posted by GitBox <gi...@apache.org>.
mattyb149 commented on PR #6586:
URL: https://github.com/apache/nifi/pull/6586#issuecomment-1293857868
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?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] ottobackwards commented on pull request #6586: NIFI-10704 - include API name of properties in processor documentation
Posted by GitBox <gi...@apache.org>.
ottobackwards commented on PR #6586:
URL: https://github.com/apache/nifi/pull/6586#issuecomment-1294305238
PropertyDescriptorDTO has the name and the display name , and you can get that from get_processor() and drilling down.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org