Fix to meet api specification for empty bodies #13415
Merged
+11
−2
Conversation
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
It should be generally acknowledged that returning an empty body for context-type application/json is not a good practice but some Confluence API endpoints do this and sadly the chance of Atlassian changing this is low so we have to deal with it.
🎉 Snyk checks have passed. No issues have been found so far.✅ security/snyk check is complete. No issues have been found. (View Details) ✅ license/snyk check is complete. No issues have been found. (View Details) |
cscheid
approved these changes
Sep 25, 2025
| } | ||
|
|
||
| private handleResponse<T>(response: Response) { | ||
| private async handleResponse<T>(response: Response) { |
There was a problem hiding this comment.
In case anyone else looks at this: the change to async here changes the type of handleResponse. That means the handleResponse call sites change as well, but inspecting the code here shows that the only two call sites are already async, and call handleResponse in tail position. That means those calls do not need an additional await.
3 tasks
|
Thanks @m1no ! |
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.
Description
This PR fixes the issue as discussed in #13414. Multiple ideas were explored to fix this:
Exception Handler
Catching the exception would be a hotfix for this particular API, but as it is a defined API in multiple API calls of the Confluence API doc, a robust solution was preferred.
Content-Length Check
The response header
Content-Lengthwith a value of0should be an excellent indicator of an empty body, but unfortunately, this header is unavailable in those requests due to CORS restrictions.Checklist
I have (if applicable):