Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: update Java examples in the API Reference docs for Events and Subscribers Endpoints #319

Merged
merged 6 commits into from
Nov 14, 2023

Conversation

m-a-r-1912
Copy link
Contributor

For this issue: 295
This draft PR is to show the progress of updating the API Reference docs for Java.
The Events methods have been updated and I'll continue to add more updated docs.

@unicodeveloper
Copy link
Contributor

Hello @m-a-r-1912 Please do you have any update for this? It has been in draft mode for a week now

@m-a-r-1912
Copy link
Contributor Author

Yes! I'll add my updates today.

@unicodeveloper
Copy link
Contributor

Thanks for adding the updates. Are there other updates you want to add this current PR? If not, can you remove it from DRAFT? @m-a-r-1912

Changed the following:
- removed recently added Java examples that seem to encounter issues with the API
- added Update Subscriber Preference Java example
- added response examples, copied from the responses that are generated on the docs website
@m-a-r-1912
Copy link
Contributor Author

m-a-r-1912 commented Nov 14, 2023

The Java example changes for the Events and Subscribers endpoints should be good to review now. I didn't update all of the Subscribers Java examples because either the SDK method seemed to cause errors with the Novu API or there isn't an equivalent SDK method for the endpoint.
Edit: Also, there's several more sections of the API Reference docs that have out of date Java examples, but those can be updated with a different PR. Updating those would keep this PR open probably for too long

@m-a-r-1912 m-a-r-1912 marked this pull request as ready for review November 14, 2023 05:25
@m-a-r-1912 m-a-r-1912 changed the title fix: update Java examples in the API Reference docs fix: update Java examples in the API Reference docs for Events and Subscribers Endpoints Nov 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants