Skip to content

Commit 577d1b4

Browse files
committed
fix: improve description for blocking runs and Record URL
1 parent 3221308 commit 577d1b4

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

openapi.json

+7-7
Original file line numberDiff line numberDiff line change
@@ -787,8 +787,8 @@
787787
"tags": [
788788
"Thread Runs"
789789
],
790-
"summary": "Create a run on a thread and wait for its output output",
791-
"description": "Create a run on a thread and wait for its output. See 'GET /runs/{run_id}/wait' for details on the return values.",
790+
"summary": "Create a run on a thread and block waiting for the result of the run",
791+
"description": "Create a run on a thread and block waiting for its output. See 'GET /runs/{run_id}/wait' for details on the return values.",
792792
"operationId": "create_and_wait_for_thread_run_output",
793793
"parameters": [
794794
{
@@ -863,8 +863,8 @@
863863
"tags": [
864864
"Thread Runs"
865865
],
866-
"summary": "Retrieve last output of a run if available",
867-
"description": "Retrieve the output of the run if available. See 'GET /runs/{run_id}/wait' for details on the return values.",
866+
"summary": "Blocks waiting for the result of the run.",
867+
"description": "Blocks waiting for the result of the run. See 'GET /runs/{run_id}/wait' for details on the return values.",
868868
"operationId": "wait_for_thread_run_output",
869869
"parameters": [
870870
{
@@ -1500,8 +1500,8 @@
15001500
"tags": [
15011501
"Stateless Runs"
15021502
],
1503-
"summary": "Retrieve last output of a run if available",
1504-
"description": "Retrieve the last output of the run. The output can be:\n * an interrupt, this happens when the agent run status is `interrupted`\n * the final result of the run, this happens when the agent run status is `success`\n * an error, this happens when the agent run status is `error` or `timeout`\n\n\nThis call blocks until the output is available.",
1503+
"summary": "Blocks waiting for the result of the run.",
1504+
"description": "Blocks waiting for the result of the run. The output can be:\n * an interrupt, this happens when the agent run status is `interrupted`\n * the final result of the run, this happens when the agent run status is `success`\n * an error, this happens when the agent run status is `error` or `timeout`\n\n\nThis call blocks until the output is available.",
15051505
"operationId": "wait_for_stateless_run_output",
15061506
"parameters": [
15071507
{
@@ -1888,7 +1888,7 @@
18881888
},
18891889
"url": {
18901890
"title": "Agent Record URL",
1891-
"description": "URL of the record. Can be a network location or a file.",
1891+
"description": "URL of the record. Can be a network location, i.e. an entry in the Agent Directory or a file.",
18921892
"type": "string",
18931893
"format": "uri"
18941894
}

0 commit comments

Comments
 (0)