docs(sdk): an absent id reads back as null, not as a failure - #190
Merged
Conversation
JavaRepository.findById answers null for an id that is not there, and findOne answers an empty Optional - neither throws, so the caller decides what absence means. Documents the controller shape that follows from it, including the trap that returning null from a controller method answers 204 and would overwrite a 404 just set. Platform side: eclipse-dirigible/dirigible#6752 (issue #6420). Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follows eclipse-dirigible/dirigible#6752 (issue #6420), which makes
JavaRepository.findByIdhonour its documented contract.The SDK pages listed
findById/findOneamong the repository methods but never said what an id that is not there does. That silence is what the issue was about: absence is an ordinary outcome, and the caller — not the repository — decides what it means.component/decorators.md— states the contract (null/ emptyOptional, neither throws) and shows the controller shape, including the trap that a controller method returningnullanswers204 No Content, which would overwrite a404just set.get-started.md— addsfindOne(id)to the method list and one sentence on the contract, linking to the details.npm run docs:buildpasses.🤖 Generated with Claude Code