@@ -333,6 +333,7 @@ Execute an action with streaming partial results. The server sends
333333 "params" : {"file_paths" : [" /path/to/file.py" ]},
334334 "partial_result_token" : " diag_1" ,
335335 "options" : {
336+ "result_formats" : [" json" , " string" ],
336337 "trigger" : " system" ,
337338 "dev_env" : " ide"
338339 }
@@ -341,10 +342,20 @@ Execute an action with streaming partial results. The server sends
341342
342343Required: ` action ` , ` project ` , ` partial_result_token ` .
343344
345+ Supported ` result_formats ` : ` "json" ` , ` "string" ` , etc. (same as ` actions/run ` ).
346+
344347** Result:** Same as ` actions/run ` (the final aggregated result).
345348
346349During execution, the server sends ` actions/partialResult ` notifications (see below).
347350
351+ > ** Guarantee:** The API server always delivers results via ` actions/partialResult `
352+ > notifications, even when an extension runner does not stream incrementally (i.e.
353+ > it collects all results internally and returns them as a single final response).
354+ > In that case the server emits the final result as a partial result notification
355+ > before returning the aggregated response. Clients can therefore rely solely on
356+ > ` actions/partialResult ` notifications to receive results and safely ignore the
357+ > response body of this request.
358+
348359---
349360
350361#### ` actions/reload `
@@ -513,11 +524,23 @@ Sent during `actions/runWithPartialResults` execution as results stream in.
513524** Params:**
514525
515526``` json
516- {"token" : " diag_1" , "value" : {"messages" : {"file.py" : [... ]}}}
527+ {
528+ "token" : " diag_1" ,
529+ "value" : {
530+ "result_by_format" : {
531+ "json" : {"messages" : {"file.py" : [... ]}},
532+ "string" : " 3 issues found in file.py"
533+ }
534+ }
535+ }
517536```
518537
519538` token ` matches the ` partial_result_token ` from the originating request.
520539
540+ ` result_by_format ` contains results in all formats requested in the originating
541+ ` actions/runWithPartialResults ` params (same structure as ` actions/run ` response,
542+ but without ` return_code ` ).
543+
521544> ** Note:** Notifications are delivered only to the client connection that
522545> initiated the corresponding ` actions/runWithPartialResults ` request. The
523546> API server does ** not** broadcast these messages to every connected client.
0 commit comments