Adding timeout capability to api_call

[edvgui]

Working on a project using this api, we recently faced the need to add a timeout feature to api_call. This allowed us to cancel some calls that wouldn't end (for reason not related to this api). This is working great for us so far, and we propose to merge it upstream.

The change made is simple, when calling api_call, an optional (no backward compatibility issue) field called timeout can be filled. Any positive integer will be translated as a timeout (in seconds) before which the call has to finish. Otherwise the request will be terminated and a TimeoutException (inheriting from ApiException) will be raised.

[chkp-yaelg]

Thank you @edvgui ,
I will test this pull request during this week.

Can you please share a specific case where you are using it?
AFAIK it can happen when using our API commands not as expected or in case of a real issue. If it is the second case then you should contact support.

[edvgui]

The issue that got us to implement this is actually not new with the checkpoint we are configuring: https://community.checkpoint.com/t5/API-CLI-Discussion-and-Samples/put-file-and-run-as-REST-API-script-keeps-showing-as-Task-in/td-p/10602

But in any case, even for new issue we might not know about yet, we would prefer to have a failure than and endless wait. The tool using the api is the Inmanta orchestrator, it might recover from a deployment failure, but not if it is stuck.

[chkp-yaelg]

Thank you @edvgui ,
You can find your fix in the new release v.1.1.2