[GitHub] [kyuubi] bowenliang123 commented on a diff in pull request #4199: [DOC] Add REST API doc for POST /batches with uploading resource

["bowenliang123 (via GitHub)" <gi...@apache.org>]

bowenliang123 commented on code in PR #4199:
URL: https://github.com/apache/kyuubi/pull/4199#discussion_r1090097197


##########
docs/client/rest/rest_api.md:
##########
@@ -371,6 +373,23 @@ Create a new batch.
 
 The created [Batch](#batch) object.
 
+### POST /batches (with uploading resource)
+
+Create a new batch with uploading resource file.
+
+#### Request Body
+- Media type: `multipart-formdata`
+- Request body structure in multiparts:
+
+| Name         | Description                                                                                      | Media Type       |
+|:-------------|:-------------------------------------------------------------------------------------------------|:-----------------|
+| batchRequest | The batch request in JSON format as request body requried in [POST /batches](#post-batches)      | application/json |
+| resourceFile | The uploading resource to execute, which will be cached on server and cleaned up after execution | File             |

Review Comment:
   Good idea and the curl example is added to the API description.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org