search

novuhq / novu-java

Java SDK for Novu - The open-source notification infrastructure for engineers. 🚀
MIT License
27 stars 22 forks source link

Outdated usage documentation for version `v1.4.0` #96

Closed shygnome closed 4 weeks ago

shygnome commented 8 months ago

It seems the examples in the usage documentation are different from the actual SDK in version v1.4.0. Any plan to update the documentation?

m-a-r-1912 commented 8 months ago

Hi @shygnome, you're talking about the Usage section in this repo's README not the documentation hosted on novu.co, right?

shygnome commented 8 months ago

Hi @shygnome, you're talking about the Usage section in this repo's README not the documentation hosted on novu.co, right?

I think both this repo's README and the one hosted in docs.novu.co are same. Like in this API reference page https://docs.novu.co/api-reference/events/trigger-event. The java example one still using HashMap object. We are supposed to use the TriggerEventRequest and other request class, right? @m-a-r-1912

m-a-r-1912 commented 8 months ago

Yeah, according to this repo, the triggerEvent method accepts a TriggerEventRequest as parameter. So any documentation using HashMap type as parameter is wrong. We might need to create a issue(s) for the Docs repo as well. Since that's the code responsible for the api-reference pages.

FYI, it appears that one of the documentation pages has a few up to date examples https://docs.novu.co/quickstarts/java. Potentially some of the examples from there could simply be copied over to the out of date docs.

Edit: I don't know if Novu maintainers already have plans to do some kind of documentation update. Probably a good idea to get feedback from them.

mayorJAY commented 4 weeks ago

Closing this as resolved