search

atlassian-api / atlassian-python-api

Atlassian Python REST API wrapper
https://atlassian-python-api.readthedocs.io
Apache License 2.0
1.29k stars 643 forks source link

[ISSUE-1241] #1241, added propagation of `advanced_mode` flag #1243

Closed 2ps closed 9 months ago

2ps commented 9 months ago

1241

added propagation of the advanced_mode flag for put, post, patch, and delete functions. Prior to this change, the advanced_mode flag was only propagated to the request method for get calls. The advanced_mode requests.Response object is very useful in having code gracefully handle rate limit 429 responses from the server since the response headers will include the necessary backoff information that the client should use before making another request.

codecov-commenter commented 9 months ago

Codecov Report

Patch and project coverage have no change.

Comparison is base (176da86) 34.47% compared to head (ffbf143) 34.47%.

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #1243 +/- ## ======================================= Coverage 34.47% 34.47% ======================================= Files 44 44 Lines 8105 8105 Branches 1118 1118 ======================================= Hits 2794 2794 Misses 5197 5197 Partials 114 114 ``` | [Files Changed](https://app.codecov.io/gh/atlassian-api/atlassian-python-api/pull/1243?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None) | Coverage Δ | | |---|---|---| | [atlassian/rest\_client.py](https://app.codecov.io/gh/atlassian-api/atlassian-python-api/pull/1243?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None#diff-YXRsYXNzaWFuL3Jlc3RfY2xpZW50LnB5) | `67.97% <ø> (ø)` | |

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

gonchik commented 9 months ago

@2ps could you update a docs please?

2ps commented 9 months ago

@2ps could you update a docs please?

Apologies for missing this. Will address in a separate PR since this one has already been merged.

2ps commented 9 months ago

@2ps could you update a docs please?

My bad, it looks like this was already included in the docs for put, post, patch, and delete but just had not been wired in. At least from my review there were no docs to update. Please do point me in the right direction if I have overlooked something.