Michael Vorburger created FINERACT-944:
------------------------------------------
Summary: Missing documentation for /notifications in both README
and the REST API in api-docs/apiLive.htm
Key: FINERACT-944
URL: https://issues.apache.org/jira/browse/FINERACT-944
Project: Apache Fineract
Issue Type: Bug
Reporter: Michael Vorburger
In https://github.com/apache/fineract/pull/832 for FINERACT-938, I discovered
that Fineract, apparently, has some kind of support for Notifications delivered
via JMS.
This feature seems to have originally been contributed in
https://github.com/apache/fineract/commit/c60c6601c07df7903214fcfbbb1145741fc0ef42
(without any JIRA...), which introduced a new /notifications endpoint to the
REST API in NotificationApiResource.
The README does not explain how this JMS support would be used or configured,
and the
https://htmlpreview.github.io/?https://github.com/apache/fineract/blob/develop/api-docs/apiLive.htm
does not seem to include any documentation about this. (BTW note that
api-docs/apiLive.htm is about to be moved in the Git repo, see
https://github.com/apache/fineract/pull/819 for FINERACT-910.)
If we want to keep this functionality, it may be useful to properly document
it? If this was more of an "experiment" (?) for which there are no known users,
then... perhaps it should be entirely removed some time? There is n urgency /
hurry, if works, and is useful to anyone.
(https://github.com/apache/fineract/pull/832 just wants to remove 1 test, not
the functionality, and this issue is really more about documenting the
functionality than proposing to remove it.)
[~awasum], [~angeh] or [~edcable] or anyone else reading this, do you know more
about the background of this? Is this actually used? :P
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
