7171 - response handling in API code#7172
Closed
poikilotherm wants to merge 1 commit intoIQSS:developfrom
Closed
Conversation
poikilotherm
added
Feature: API
Component: Code Infrastructure
poikilotherm
requested review from
landreev,
matthew-a-dunlap,
michbarsinai,
pdurbin,
qqmyers,
scolapasta and
sekmiller
This was referenced Aug 10, 2020
michbarsinai
approved these changes
Aug 10, 2020
Member
michbarsinai
left a comment
michbarsinai
left a comment
There was a problem hiding this comment.
Agreed that a more consistent approach might be useful. The correct way for handling a specific error also depends on the usage sites (e.g. general handler vs. an AbstractApiBean subclass) so we may end up with 2 approaches rather than one.
At any event, it's good to have a discussion about this, and to have some clear guidelines in place.
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
4 participants
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.
THIS IS A DRAFT AND SUBJECT TO CHANGE
What this PR does / why we need it:
A document-driven-design approach starting a discussion how to do responses in the JAX-RS API code.
There are many different approaches in use, adding technical debts. We should lint and refactor a bit.
Which issue(s) this PR closes:
Relates to #7171
Special notes for your reviewer:
None yet.
Suggestions on how to test this:
None yet (docs only for now)
Does this PR introduce a user interface change? If mockups are available, please link/include them here:
Not yet. I might change the API UX.
Is there a release notes update needed for this change?:
There will. But not now.
Additional documentation:
None yet.