Skip to content
This repository was archived by the owner on Aug 14, 2025. It is now read-only.

Comments

docs(sdk): Add Java SDK documentation#178

Merged
mbasadi merged 2 commits intomainfrom
QLhfO3eF/3194-java-sdk-docs
Apr 22, 2025
Merged

docs(sdk): Add Java SDK documentation#178
mbasadi merged 2 commits intomainfrom
QLhfO3eF/3194-java-sdk-docs

Conversation

@mbasadi
Copy link
Member

@mbasadi mbasadi commented Apr 21, 2025

Changes

  • Added Java as a supported environment in intro.md\n- Added Java SDK installation instructions to quick-start guide
  • Added comprehensive Java SDK documentation to server reference

Additional Notes

This PR adds full documentation for the new Java SDK (version 0.1.0)

- Updated the introduction to include Java as a supported environment.
- Enhanced the quick-start guide with Java code samples for sending notifications, including Maven dependencies and usage examples.
- Added Java support details in the server reference documentation, covering initialization, user creation, and notification sending.

This addition improves the SDK's accessibility for Java developers.
@mbasadi mbasadi requested a review from GreyNewfie April 21, 2025 16:27
| ----------------- | ------ | --------------------------------------------------------------------------------------------------------------------- |
| `CLIENT_ID`\* | string | Your NotificationAPI account clientId. You can get it from [here](https://app.notificationapi.com/environments). |
| `CLIENT_SECRET`\* | string | Your NotificationAPI account client secret. You can get it from [here](https://app.notificationapi.com/environments). |

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here's what I was referring to. Under the "Setup & Initialization" just including the baseURL property. We do also have examples of how to use it in other examples.

Screenshot 2025-04-21 at 5 10 09 PM

- Bump Maven dependency version from 0.1.0 to 0.2.0.
- Update Java initialization examples to include a base URL parameter for region-specific API endpoints.
- Add region-specific examples for EU and CA in the server reference documentation.

These changes enhance clarity and usability for Java developers integrating with the NotificationAPI.
@mbasadi mbasadi requested a review from GreyNewfie April 22, 2025 14:01
@mbasadi mbasadi merged commit 1193cb6 into main Apr 22, 2025
1 check passed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants