fix(docs): correct workflow API parameter name from workflow_id to workflow_run_id (#22587)
This commit is contained in:
@@ -333,7 +333,7 @@ Workflow applications offers non-session support and is ideal for translation, a
|
||||
---
|
||||
|
||||
<Heading
|
||||
url='/workflows/run/:workflow_id'
|
||||
url='/workflows/run/:workflow_run_id'
|
||||
method='GET'
|
||||
title='Get Workflow Run Detail'
|
||||
name='#get-workflow-run-detail'
|
||||
@@ -342,7 +342,7 @@ Workflow applications offers non-session support and is ideal for translation, a
|
||||
<Col>
|
||||
Retrieve the current execution results of a workflow task based on the workflow execution ID.
|
||||
### Path
|
||||
- `workflow_id` (string) Workflow ID, can be obtained from the streaming chunk return
|
||||
- `workflow_run_id` (string) Workflow run ID, can be obtained from the streaming chunk return
|
||||
### Response
|
||||
- `id` (string) ID of workflow execution
|
||||
- `workflow_id` (string) ID of related workflow
|
||||
@@ -358,9 +358,9 @@ Workflow applications offers non-session support and is ideal for translation, a
|
||||
</Col>
|
||||
<Col sticky>
|
||||
### Request Example
|
||||
<CodeGroup title="Request" tag="GET" label="/workflows/run/:workflow_id" targetCode={`curl -X GET '${props.appDetail.api_base_url}/workflows/run/:workflow_id' \\\n-H 'Authorization: Bearer {api_key}' \\\n-H 'Content-Type: application/json'`}>
|
||||
<CodeGroup title="Request" tag="GET" label="/workflows/run/:workflow_run_id" targetCode={`curl -X GET '${props.appDetail.api_base_url}/workflows/run/:workflow_run_id' \\\n-H 'Authorization: Bearer {api_key}' \\\n-H 'Content-Type: application/json'`}>
|
||||
```bash {{ title: 'cURL' }}
|
||||
curl -X GET '${props.appDetail.api_base_url}/workflows/run/:workflow_id' \
|
||||
curl -X GET '${props.appDetail.api_base_url}/workflows/run/:workflow_run_id' \
|
||||
-H 'Authorization: Bearer {api_key}' \
|
||||
-H 'Content-Type: application/json'
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user