Add Workflow Logs API docs #391
Open
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
sancar
reviewed
Feb 6, 2025
| --- | ||
|
|
||
| <Warning> | ||
| The flat events provide a more detailed version of the [List Workflow Events API](/workflow/rest/runs/event-logs). If you need an overview of a workflow run, that API is more useful, as it returns grouped and processed data. |
There was a problem hiding this comment.
This link needs to be updated.
/workflow/rest/runs/event-logs -> /workflow/rest/runs/runs
sancar
reviewed
Feb 6, 2025
| </ParamField> | ||
|
|
||
| <ParamField query="state" type="string"> | ||
| Filter logs by [state](/qstash/howto/debug-logs) |
There was a problem hiding this comment.
These are the states of the Workflow's right. Not the messages.
I guess we need to remove the link and mention the differnce.
There was a problem hiding this comment.
I think, I entered the comment on the wrong API.
This API for flat events. That means, user can enter message events and also RUN_STARTED , WAITER_ADDED etc. So the linked doc is still not enough.
sancar
reviewed
Feb 6, 2025
| </ParamField> | ||
|
|
||
| <ParamField query="state" type="string"> | ||
| Filter workflow runs by [state](/qstash/howto/debug-logs) |
There was a problem hiding this comment.
These are the states of the Workflow's right. Not the messages.
I guess we need to remove the link and mention that these can only be RUN_STARTED/RUN_SUCCESS etc.
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.
Logs API allows users to fetch details about their workflow runs.