Fixes #10152: Missing async option in the doc #283
Merged
Conversation
This file contains 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
8_reference/80_relay_api.txt
Outdated
| @@ -41,6 +41,7 @@ This API provides the following methods: | |||
| The general parameters are: | |||
|
|
|||
| * `keep_output` = *true* or *false*: Should the agent output be returned (default: *false*) | |||
| * `asynchronous` = *true* or *false*: If `keep_output` is true, should the output be returned as it is produced (contrary to waiting for the end of the run). If it is false, should the call return just after starting the agent, without waiting for the end. (default: *false*) | |||
There was a problem hiding this comment.
In all cases, even if we don't keep_output, if asynchronous is 'false' we wait for return of 'query' or 'command', asynchronous without output returns directly, meaning you don't have to wait to check if it has run correctly on your xxxx nodes (which can be quite long)
|
Commit modified |
amousset
force-pushed
the
ust_10152/missing_async_option_in_the_doc
branch
from
5cf3cd2
to
470764c
Compare
|
OK, merging this PR |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
https://www.rudder-project.org/redmine/issues/10152