Skip to content

Workflow API with OpenAPI #645

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.

Sign up for GitHub

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

Draft
sancar wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

Workflow API with OpenAPI #645

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3f050ed
added workflow open api and fixed qstash navigation
sancar Mar 10, 2026
9b0132a
trigger rest api
sancar Mar 10, 2026
b0ee9f3
contine to move workflow docs to openapi
sancar Mar 12, 2026
fb96c99
logs
sancar Mar 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 53 additions & 18 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@
"groups": [
{
"group": "Introduction",
"pages": ["introduction"]
"pages": [
"introduction"
]
},
{
"group": "Concepts",
Expand Down Expand Up @@ -53,7 +55,6 @@
}
]
},

{
"tab": "Redis",
"groups": [
Expand Down Expand Up @@ -548,7 +549,9 @@
},
{
"group": "PubSub",
"pages": ["redis/sdks/py/commands/pubsub/publish"]
"pages": [
"redis/sdks/py/commands/pubsub/publish"
]
},
{
"group": "Scripts",
Expand Down Expand Up @@ -972,11 +975,15 @@
},
{
"group": "Examples",
"pages": ["vector/examples"]
"pages": [
"vector/examples"
]
},
{
"group": "Help",
"pages": ["vector/help/faq"]
"pages": [
"vector/help/faq"
]
}
]
}
Expand Down Expand Up @@ -1062,12 +1069,18 @@
]
},
{
"group": "REST API",
"openapi": {
"source": "qstash/openapi.yaml",
"directory": "qstash/api-refence"
},
"pages": ["qstash/api/authentication", "qstash/api/api-ratelimiting"]
"group": "REST",
"pages": [
"qstash/api/authentication",
"qstash/api/api-ratelimiting",
{
"group": "API",
"openapi": {
"source": "qstash/openapi.yaml",
"directory": "qstash/api-refence"
}
}
]
},
{
"group": "SDKs",
Expand Down Expand Up @@ -1319,6 +1332,13 @@
"workflow/agents/examples"
]
},
{
"group": "REST API GENERATED",
"openapi": {
"source": "workflow/openapi.yaml",
"directory": "workflow/api-refence"
}
},
{
"group": "REST API",
"pages": [
Expand Down Expand Up @@ -1416,7 +1436,9 @@
},
{
"group": "Search UI",
"pages": ["search/ui/search-bar"]
"pages": [
"search/ui/search-bar"
]
},
{
"group": "Features",
Expand Down Expand Up @@ -1473,7 +1495,9 @@
},
{
"group": "Integrations",
"pages": ["search/integrations/docusaurus"]
"pages": [
"search/integrations/docusaurus"
]
},
{
"group": "Tools",
Expand All @@ -1484,7 +1508,9 @@
},
{
"group": "Help",
"pages": ["search/help/faq"]
"pages": [
"search/help/faq"
]
}
]
}
Expand Down Expand Up @@ -1656,11 +1682,15 @@
},
{
"group": "Pulumi",
"pages": ["devops/pulumi/overview"]
"pages": [
"devops/pulumi/overview"
]
},
{
"group": "CLI",
"pages": ["devops/cli/overview"]
"pages": [
"devops/cli/overview"
]
}
]
}
Expand Down Expand Up @@ -1731,7 +1761,12 @@
}
},
"contextual": {
"options": ["copy", "view", "chatgpt", "claude"]
"options": [
"copy",
"view",
"chatgpt",
"claude"
]
},
"redirects": [
{
Expand Down Expand Up @@ -1879,4 +1914,4 @@
"destination": "/box/overall/quickstart"
}
]
}
}
31 changes: 4 additions & 27 deletions qstash/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -679,9 +679,9 @@ paths:
type: string
description: |
Flow Control parallelism, rate and period values to use for rate limiting messages for the given key.

Format: `parallelism=<value>, rate=<value>, period=<value>`.
Make sure you pass `Upstash-Flow-Control-Key` header as well to define the key.

See [flow control](/qstash/features/flowcontrol) for details.
- name: Upstash-Deduplication-Id
in: header
schema:
Expand Down Expand Up @@ -749,7 +749,7 @@ paths:
schema:
type: string
description: |
You can define a failure callback url that will be called when a delivery is failed. That is when all the defined retries are exhausted. See the content of what will be delivered to a failure callback here
You can define a failure callback url that will be called when a delivery is failed. That is when all the defined retries are exhausted. See the content of what will be delivered to a failure callback (here)[/qstash/features/callbacks#how-do-i-use-callbacks]

- Failure callback URL must be prefixed with a valid protocol (http:// or https://)
- Failure callbacks are charged as a regular message.
Expand Down Expand Up @@ -825,7 +825,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Error'

/v2/enqueue/{queueName}/{destination}:
post:
summary: Enqueue a Message
Expand Down Expand Up @@ -1033,7 +1032,7 @@ paths:
schema:
type: string
description: |
You can define a failure callback url that will be called when a delivery is failed. That is when all the defined retries are exhausted. See the content of what will be delivered to a failure callback here
You can define a failure callback url that will be called when a delivery is failed. That is when all the defined retries are exhausted. See the content of what will be delivered to a failure callback [here](/qstash/features/callbacks#how-do-i-use-callbacks)

- Failure callback URL must be prefixed with a valid protocol (http:// or https://)
- Failure callbacks are charged as a regular message.
Expand Down Expand Up @@ -1109,7 +1108,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Error'

/v2/batch:
post:
summary: Batch Messages
Expand Down Expand Up @@ -1165,7 +1163,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Error'

/v2/messages/{messageId}:
get:
summary: Get a Message
Expand Down Expand Up @@ -1218,7 +1215,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Error'

/v2/messages:
delete:
summary: Bulk Cancel Messages
Expand Down Expand Up @@ -1317,7 +1313,6 @@ paths:
cancelled:
type: integer
description: Number of messages cancelled

/v2/queues:
post:
summary: Upsert a Queue
Expand Down Expand Up @@ -1380,7 +1375,6 @@ paths:
type: array
items:
$ref: '#/components/schemas/Queue'

/v2/queues/{queueName}:
get:
summary: Get a Queue
Expand Down Expand Up @@ -1429,7 +1423,6 @@ paths:
responses:
'200':
description: Queue deleted successfully

/v2/queues/{queueName}/pause:
post:
summary: Pause Queue
Expand Down Expand Up @@ -1461,7 +1454,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Error'

/v2/queues/{queueName}/resume:
post:
summary: Resume Queue
Expand Down Expand Up @@ -1493,7 +1485,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Error'

/v2/schedules/{destination}:
post:
summary: Create a Schedule
Expand Down Expand Up @@ -1764,7 +1755,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Error'

/v2/schedules:
get:
summary: List schedules
Expand All @@ -1780,7 +1770,6 @@ paths:
type: array
items:
$ref: '#/components/schemas/Schedule'

/v2/schedules/{scheduleId}:
get:
summary: Get a Schedule
Expand Down Expand Up @@ -1823,7 +1812,6 @@ paths:
responses:
'200':
description: Schedule deleted successfully

/v2/schedules/{scheduleId}/pause:
post:
summary: Pause a Schedule
Expand All @@ -1845,7 +1833,6 @@ paths:
responses:
'200':
description: Schedule paused successfully

/v2/schedules/{scheduleId}/resume:
post:
summary: Resume a Schedule
Expand All @@ -1867,7 +1854,6 @@ paths:
responses:
'200':
description: Schedule resumed successfully

/v2/topics:
get:
summary: List URL Groups
Expand All @@ -1883,7 +1869,6 @@ paths:
type: array
items:
$ref: '#/components/schemas/URLGroup'

/v2/topics/{urlGroupName}:
get:
summary: Get a URL Group
Expand Down Expand Up @@ -1934,7 +1919,6 @@ paths:
responses:
'200':
description: URL Group deleted successfully

/v2/topics/{urlGroupName}/endpoints:
post:
summary: Upsert URL Group and Endpoint
Expand Down Expand Up @@ -2010,7 +1994,6 @@ paths:
responses:
'200':
description: Endpoint(s) removed successfully

/v2/dlq:
get:
summary: List DLQ messages
Expand Down Expand Up @@ -2204,7 +2187,6 @@ paths:
deleted:
type: integer
description: The number of messages that were deleted.

/v2/dlq/{dlqId}:
get:
summary: Get a DLQ message
Expand Down Expand Up @@ -2257,7 +2239,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Error'

/v2/dlq/retry/{dlqId}:
post:
summary: Retry a DLQ message
Expand Down Expand Up @@ -2297,7 +2278,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Error'

/v2/dlq/retry:
post:
summary: Bulk Retry DLQ messages
Expand Down Expand Up @@ -2403,7 +2383,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Error'

/v2/flowControl:
get:
summary: List Flow Control Keys
Expand Down Expand Up @@ -2481,7 +2460,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/SigningKeys'

/v2/keys/rotate:
post:
summary: Rotate Signing Keys
Expand All @@ -2503,7 +2481,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/SigningKeys'

/v2/logs:
get:
summary: List Logs
Expand Down
Loading