-
Notifications
You must be signed in to change notification settings - Fork 66
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Evolve documentation of update polling parameters #406
base: master
Are you sure you want to change the base?
Conversation
a732611
to
ccb8b29
Compare
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How long implies that this specifies a duration?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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;
...
}
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be cool if you could update the variants in the enum too to specify what they mean as a request (already exists) and what they mean as a return value (which I don't think they say, and would be nice to have).
No description provided.