Skip to content

SdkException java doc changed #6347

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

Merged
merged 4 commits into from
Aug 14, 2025
Merged

Conversation

Fred1155
Copy link
Contributor

Motivation and Context

Javadocs for SdkException state: Base class for all exceptions thrown by the SDK.
However for some errors such as SocketException we throw UncheckedIOException , which leads to issues if customers rely on catching SdkException to retry. We can't make changes due to backwards compatibility, this pr is to make the Java doc more accurate

Modifications

Testing

Screenshots (if appropriate)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)

Checklist

  • I have read the CONTRIBUTING document
  • Local run of mvn install succeeds
  • My code follows the code style of this project
  • My change requires a change to the Javadoc documentation
  • I have updated the Javadoc documentation accordingly
  • I have added tests to cover my changes
  • All new and existing tests passed
  • I have added a changelog entry. Adding a new entry must be accomplished by running the scripts/new-change script and following the instructions. Commit the new file created by the script in .changes/next-release with your changes.
  • My change is to implement 1.11 parity feature and I have updated LaunchChangelog

License

  • I confirm that this pull request can be released under the Apache 2 license

@Fred1155 Fred1155 requested a review from a team as a code owner August 14, 2025 00:00
@Fred1155 Fred1155 added changelog-not-required Indicate changelog entry is not required for a specific PR no-api-surface-area-change Indicate there is no API surface area change and thus API surface area review is not required labels Aug 14, 2025
Copy link

@Fred1155 Fred1155 added this pull request to the merge queue Aug 14, 2025
Merged via the queue into master with commit 9316753 Aug 14, 2025
37 of 39 checks passed
Copy link

This pull request has been closed and the conversation has been locked. Comments on closed PRs are hard for our team to see. If you need more assistance, please open a new issue that references this one.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 14, 2025
@Fred1155 Fred1155 deleted the bole/change_exception_javadoc branch August 14, 2025 21:52
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
changelog-not-required Indicate changelog entry is not required for a specific PR no-api-surface-area-change Indicate there is no API surface area change and thus API surface area review is not required
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants