Please document isIdempotent flag

[estomagordo]

What problem does your feature request address?

In version 3.34.0 there is a new boolean value added to some methods in http_request.go and http_util.go but they are not documented in the changelog.

I am not sure how to make my code work, using this version. I.e. should I usetrue or false, and why?

Describe the desired solution

Document this usage

Alternatives considered

No response

Additional context

No response

[cb-alish]

Hi @estomagordo,
We recently added a retry feature that you can use by following the docs in this readme.
The SetIdempotency method is only meant for internal library use and shouldn't be used by external users. Is this causing issues with your code? If so, please let us know.

[estomagordo]

Hi @cb-alish

So in our code base, we call the function Do() in http_request.go. The issue for me is that I now need to pass a boolean, which I don't see documented anywhere. But upon inspecting your code, I did conclude that I should pass false, since this feature seems to interact with headers that we do not pass, yes.

[cb-alish]

Hi @estomagordo,

Thanks for the feedback! If you're not planning to use the retry config, you can pass any boolean value to the Do() method - it won't affect your implementation.

However, I'm curious - why are you calling the Do() method directly? This method is intended for internal library use and isn't part of the public API that external users should interact with.

[estomagordo]

I suspected that this might be the case @cb-alish so thank you for confirming! I am relatively new to the codebase (and Golang in general) and I was not around when this integration was first built.

Looking at the code some more, I think that maybe this logic can be removed entirely, actually. It is only called in tests and so it might just be a remnant of some since-long outdated behaviour.