From d99ad31295878d46963a14ce2186ac1602a8b034 Mon Sep 17 00:00:00 2001 From: sancar Date: Tue, 26 Aug 2025 16:41:53 +0300 Subject: [PATCH 1/2] Document Rest API for QStash Label --- _snippets/qstash-dlq-message-type.mdx | 4 ++++ _snippets/qstash-message-type.mdx | 4 ++++ _snippets/workflow/workflow-dlq-message-type.mdx | 5 ++++- qstash/api/dlq/listMessages.mdx | 4 +++- qstash/api/events/list.mdx | 7 +++++++ qstash/api/logs/list.mdx | 6 ++++++ workflow/rest/dlq/list.mdx | 4 +++- workflow/rest/runs/logs.mdx | 8 ++++++++ 8 files changed, 39 insertions(+), 3 deletions(-) diff --git a/_snippets/qstash-dlq-message-type.mdx b/_snippets/qstash-dlq-message-type.mdx index 2f7b6c01..63223f30 100644 --- a/_snippets/qstash-dlq-message-type.mdx +++ b/_snippets/qstash-dlq-message-type.mdx @@ -82,3 +82,7 @@ The base64 encoded response body of the last failed deliver attempt if the response body contains a non-utf8 char only, empty otherwise. + + + The label of the message assigned by the user. + \ No newline at end of file diff --git a/_snippets/qstash-message-type.mdx b/_snippets/qstash-message-type.mdx index 0ccb367b..6eaa21c4 100644 --- a/_snippets/qstash-message-type.mdx +++ b/_snippets/qstash-message-type.mdx @@ -56,4 +56,8 @@ IP address of the publisher of this message. + + + + The label of the message assigned by the user. \ No newline at end of file diff --git a/_snippets/workflow/workflow-dlq-message-type.mdx b/_snippets/workflow/workflow-dlq-message-type.mdx index f6abc0e4..c562d651 100644 --- a/_snippets/workflow/workflow-dlq-message-type.mdx +++ b/_snippets/workflow/workflow-dlq-message-type.mdx @@ -69,4 +69,7 @@ Detailed information about the failure callback, including state, response body, response status and response headers. - \ No newline at end of file + + +The label of the run assigned by the user. + \ No newline at end of file diff --git a/qstash/api/dlq/listMessages.mdx b/qstash/api/dlq/listMessages.mdx index 39d0301d..10901e81 100644 --- a/qstash/api/dlq/listMessages.mdx +++ b/qstash/api/dlq/listMessages.mdx @@ -60,7 +60,9 @@ List all messages currently inside the DLQ The sorting order of DLQ messages by timestamp. Valid values are "earliestFirst" and "latestFirst". The default is "earliestFirst". - + + Filter DLQ messages by the label of the message assigned by the user. + ## Response diff --git a/qstash/api/events/list.mdx b/qstash/api/events/list.mdx index 549685b2..4e729c37 100644 --- a/qstash/api/events/list.mdx +++ b/qstash/api/events/list.mdx @@ -68,6 +68,10 @@ authMethod: "bearer" The sorting order of events by timestamp. Valid values are "earliestFirst" and "latestFirst". The default is "latestFirst". + + Filter event by the label of the message assigned by the user. + + ## Response @@ -165,6 +169,9 @@ If no cursor is returned, you have reached the end of the events. The mathematical expression used to calculate delay between retry attempts. If not set, [the default backoff](/qstash/features/retry) is used. + + The label of the message assigned by the user. + diff --git a/qstash/api/logs/list.mdx b/qstash/api/logs/list.mdx index 39aff7d9..3722a4f3 100644 --- a/qstash/api/logs/list.mdx +++ b/qstash/api/logs/list.mdx @@ -63,6 +63,9 @@ authMethod: "bearer" The sorting order of logs by timestamp. Valid values are "earliestFirst" and "latestFirst". The default is "latestFirst". + + Filter event by the label of the message assigned by the user. + ## Response @@ -160,6 +163,9 @@ If no cursor is returned, you have reached the end of the logs. The mathematical expression used to calculate delay between retry attempts. If not set, [the default backoff](/qstash/features/retry) is used. + + The label of the message assigned by the user. + diff --git a/workflow/rest/dlq/list.mdx b/workflow/rest/dlq/list.mdx index f07337f3..c5544f6c 100644 --- a/workflow/rest/dlq/list.mdx +++ b/workflow/rest/dlq/list.mdx @@ -36,7 +36,9 @@ List all failed workflow runs currently inside the Dead Letter Queue. The number of workflow runs to return. Default and maximum is 100. - + + Filter workflow run by the label assigned by the user. + ## Response diff --git a/workflow/rest/runs/logs.mdx b/workflow/rest/runs/logs.mdx index 9ed988f4..3a52b33d 100644 --- a/workflow/rest/runs/logs.mdx +++ b/workflow/rest/runs/logs.mdx @@ -57,6 +57,10 @@ To uniquely identify a single workflow run, include the `workflowCreatedAt` time The number of workflow runs to return. Default and max is 10. + + Filter workflow run by the label assigned by the user. + + ## Response @@ -95,6 +99,10 @@ To uniquely identify a single workflow run, include the `workflowCreatedAt` time The Unix timestamp (in milliseconds) when the workflow run was completed, if applicable. + + The label of the run assigned by the user on trigger. + + The details of the failure callback message, if a failure function was defined for the workflow. From 4c4d650c1849f807ea1e94da33c17719d547ac44 Mon Sep 17 00:00:00 2001 From: sancar Date: Thu, 28 Aug 2025 12:17:25 +0300 Subject: [PATCH 2/2] no need for documenting deprecated api --- qstash/api/events/list.mdx | 7 ------- 1 file changed, 7 deletions(-) diff --git a/qstash/api/events/list.mdx b/qstash/api/events/list.mdx index 4e729c37..549685b2 100644 --- a/qstash/api/events/list.mdx +++ b/qstash/api/events/list.mdx @@ -68,10 +68,6 @@ authMethod: "bearer" The sorting order of events by timestamp. Valid values are "earliestFirst" and "latestFirst". The default is "latestFirst". - - Filter event by the label of the message assigned by the user. - - ## Response @@ -169,9 +165,6 @@ If no cursor is returned, you have reached the end of the events. The mathematical expression used to calculate delay between retry attempts. If not set, [the default backoff](/qstash/features/retry) is used. - - The label of the message assigned by the user. -