Evolve documentation of update polling parameters #406
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
cretz
approved these changes
May 20, 2024
cretz
approved these changes
May 20, 2024
dandavison
force-pushed
the
update-polling-edits
branch
from
a732611
to
ccb8b29
Compare
yiminc
reviewed
May 20, 2024
openapi/openapiv2.json
Outdated
| @@ -3457,7 +3457,7 @@ | |||
| }, | |||
| "waitPolicy": { | |||
| "$ref": "#/definitions/v1WaitPolicy", | |||
| "description": "Describes when this request should return - basically whether the\nupdate is synchronous, asynchronous, or somewhere in between." | |||
| "description": "How long to wait before returning control to the caller." | |||
There was a problem hiding this comment.
How long implies that this specifies a duration?
There was a problem hiding this comment.
Yes, you're right. I've now changed it to
message UpdateWorkflowExecutionRequest {
...
// When this request should return.
temporal.api.update.v1.WaitPolicy wait_policy = 4;
...
}
message PollWorkflowExecutionUpdateRequest {
...
// When this request should return. Omit to request a non-blocking poll.
temporal.api.update.v1.WaitPolicy wait_policy = 4;
...
}
Sushisource
approved these changes
May 20, 2024
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.
No description provided.