Skip to content

armgit / E2B

Public Imported from GitHub
0

Open-source, secure environment with real-world tools for enterprise-grade agents.

Generate playground API client

Tomas Valenta2a610fffe9ab
diff --git a/api-service/.openapi-generator/FILES b/api-service/.openapi-generator/FILES
index 42d8057ef..44b3a4e1e 100644
--- a/api-service/.openapi-generator/FILES
+++ b/api-service/.openapi-generator/FILES
@@ -17,6 +17,7 @@ playground_client/docs/ReadFilesystemFileResponse.md
playground_client/docs/RunProcessParams.md
playground_client/docs/RunProcessResponse.md
playground_client/docs/WriteFilesystemFileRequest.md
+playground_client/docs/WriteProcessStdinRequest.md
playground_client/exceptions.py
playground_client/models/__init__.py
playground_client/models/create_session_response.py
@@ -32,6 +33,7 @@ playground_client/models/read_filesystem_file_response.py
playground_client/models/run_process_params.py
playground_client/models/run_process_response.py
playground_client/models/write_filesystem_file_request.py
+playground_client/models/write_process_stdin_request.py
playground_client/rest.py
playground_client/test/__init__.py
playground_client/test/test_create_session_response.py
@@ -48,4 +50,5 @@ playground_client/test/test_read_filesystem_file_response.py
playground_client/test/test_run_process_params.py
playground_client/test/test_run_process_response.py
playground_client/test/test_write_filesystem_file_request.py
+playground_client/test/test_write_process_stdin_request.py
playground_client_README.md
diff --git a/api-service/playground_client/__init__.py b/api-service/playground_client/__init__.py
index 31b0eb47f..1c1574a13 100644
--- a/api-service/playground_client/__init__.py
+++ b/api-service/playground_client/__init__.py
@@ -42,3 +42,4 @@ from playground_client.models.read_filesystem_file_response import ReadFilesyste
from playground_client.models.run_process_params import RunProcessParams
from playground_client.models.run_process_response import RunProcessResponse
from playground_client.models.write_filesystem_file_request import WriteFilesystemFileRequest
+from playground_client.models.write_process_stdin_request import WriteProcessStdinRequest
diff --git a/api-service/playground_client/api/default_api.py b/api-service/playground_client/api/default_api.py
index 4de9c899d..79eb84af0 100644
--- a/api-service/playground_client/api/default_api.py
+++ b/api-service/playground_client/api/default_api.py
@@ -17,7 +17,7 @@ import re # noqa: F401
from pydantic import validate_arguments, ValidationError
from typing_extensions import Annotated
-from pydantic import StrictStr
+from pydantic import StrictBool, StrictStr
from playground_client.models.create_session_response import CreateSessionResponse
from playground_client.models.create_sessions_request import CreateSessionsRequest
@@ -26,6 +26,7 @@ from playground_client.models.read_filesystem_file_response import ReadFilesyste
from playground_client.models.run_process_params import RunProcessParams
from playground_client.models.run_process_response import RunProcessResponse
from playground_client.models.write_filesystem_file_request import WriteFilesystemFileRequest
+from playground_client.models.write_process_stdin_request import WriteProcessStdinRequest
from playground_client.api_client import ApiClient
from playground_client.exceptions import ( # noqa: F401
@@ -471,6 +472,161 @@ class DefaultApi(object):
collection_formats=_collection_formats,
_request_auth=_params.get('_request_auth'))
+ @validate_arguments
+ def get_process(self, id : StrictStr, process_id : StrictStr, wait : StrictBool, **kwargs) -> RunProcessResponse: # noqa: E501
+ """get_process # noqa: E501
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+
+ >>> thread = api.get_process(id, process_id, wait, async_req=True)
+ >>> result = thread.get()
+
+ :param id: (required)
+ :type id: str
+ :param process_id: (required)
+ :type process_id: str
+ :param wait: (required)
+ :type wait: bool
+ :param async_req: Whether to execute the request asynchronously.
+ :type async_req: bool, optional
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
+ be returned without reading/decoding response
+ data. Default is True.
+ :type _preload_content: bool, optional
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :return: Returns the result object.
+ If the method is called asynchronously,
+ returns the request thread.
+ :rtype: RunProcessResponse
+ """
+ kwargs['_return_http_data_only'] = True
+ return self.get_process_with_http_info(id, process_id, wait, **kwargs) # noqa: E501
+
+ @validate_arguments
+ def get_process_with_http_info(self, id : StrictStr, process_id : StrictStr, wait : StrictBool, **kwargs): # noqa: E501
+ """get_process # noqa: E501
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+
+ >>> thread = api.get_process_with_http_info(id, process_id, wait, async_req=True)
+ >>> result = thread.get()
+
+ :param id: (required)
+ :type id: str
+ :param process_id: (required)
+ :type process_id: str
+ :param wait: (required)
+ :type wait: bool
+ :param async_req: Whether to execute the request asynchronously.
+ :type async_req: bool, optional
+ :param _return_http_data_only: response data without head status code
+ and headers
+ :type _return_http_data_only: bool, optional
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
+ be returned without reading/decoding response
+ data. Default is True.
+ :type _preload_content: bool, optional
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the authentication
+ in the spec for a single request.
+ :type _request_auth: dict, optional
+ :type _content_type: string, optional: force content-type for the request
+ :return: Returns the result object.
+ If the method is called asynchronously,
+ returns the request thread.
+ :rtype: tuple(RunProcessResponse, status_code(int), headers(HTTPHeaderDict))
+ """
+
+ _params = locals()
+
+ _all_params = [
+ 'id',
+ 'process_id',
+ 'wait'
+ ]
+ _all_params.extend(
+ [
+ 'async_req',
+ '_return_http_data_only',
+ '_preload_content',
+ '_request_timeout',
+ '_request_auth',
+ '_content_type',
+ '_headers'
+ ]
+ )
+
+ # validate the arguments
+ for _key, _val in _params['kwargs'].items():
+ if _key not in _all_params:
+ raise ApiTypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method get_process" % _key
+ )
+ _params[_key] = _val
+ del _params['kwargs']
+
+ _collection_formats = {}
+
+ # process the path parameters
+ _path_params = {}
+ if _params['id']:
+ _path_params['id'] = _params['id']
+ if _params['process_id']:
+ _path_params['processID'] = _params['process_id']
+
+ # process the query parameters
+ _query_params = []
+ if _params.get('wait') is not None: # noqa: E501
+ _query_params.append(('wait', _params['wait']))
+
+ # process the header parameters
+ _header_params = dict(_params.get('_headers', {}))
+
+ # process the form parameters
+ _form_params = []
+ _files = {}
+
+ # process the body parameter
+ _body_params = None
+
+ # set the HTTP header `Accept`
+ _header_params['Accept'] = self.api_client.select_header_accept(
+ ['application/json']) # noqa: E501
+
+ # authentication setting
+ _auth_settings = [] # noqa: E501
+
+ _response_types_map = {
+ '200': "RunProcessResponse",
+ }
+
+ return self.api_client.call_api(
+ '/sessions/{id}/process/{processID}', 'GET',
+ _path_params,
+ _query_params,
+ _header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ response_types_map=_response_types_map,
+ auth_settings=_auth_settings,
+ async_req=_params.get('async_req'),
+ _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
+ _preload_content=_params.get('_preload_content', True),
+ _request_timeout=_params.get('_request_timeout'),
+ collection_formats=_collection_formats,
+ _request_auth=_params.get('_request_auth'))
+
@validate_arguments
def list_filesystem_dir(self, id : StrictStr, path : StrictStr, **kwargs) -> ListFilesystemDirResponse: # noqa: E501
"""list_filesystem_dir # noqa: E501
@@ -910,17 +1066,19 @@ class DefaultApi(object):
_request_auth=_params.get('_request_auth'))
@validate_arguments
- def run_process(self, id : StrictStr, run_process_params : RunProcessParams, **kwargs) -> RunProcessResponse: # noqa: E501
- """run_process # noqa: E501
+ def start_process(self, id : StrictStr, wait : StrictBool, run_process_params : RunProcessParams, **kwargs) -> RunProcessResponse: # noqa: E501
+ """start_process # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.run_process(id, run_process_params, async_req=True)
+ >>> thread = api.start_process(id, wait, run_process_params, async_req=True)
>>> result = thread.get()
:param id: (required)
:type id: str
+ :param wait: (required)
+ :type wait: bool
:param run_process_params: (required)
:type run_process_params: RunProcessParams
:param async_req: Whether to execute the request asynchronously.
@@ -939,20 +1097,22 @@ class DefaultApi(object):
:rtype: RunProcessResponse
"""
kwargs['_return_http_data_only'] = True
- return self.run_process_with_http_info(id, run_process_params, **kwargs) # noqa: E501
+ return self.start_process_with_http_info(id, wait, run_process_params, **kwargs) # noqa: E501
@validate_arguments
- def run_process_with_http_info(self, id : StrictStr, run_process_params : RunProcessParams, **kwargs): # noqa: E501
- """run_process # noqa: E501
+ def start_process_with_http_info(self, id : StrictStr, wait : StrictBool, run_process_params : RunProcessParams, **kwargs): # noqa: E501
+ """start_process # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.run_process_with_http_info(id, run_process_params, async_req=True)
+ >>> thread = api.start_process_with_http_info(id, wait, run_process_params, async_req=True)
>>> result = thread.get()
:param id: (required)
:type id: str
+ :param wait: (required)
+ :type wait: bool
:param run_process_params: (required)
:type run_process_params: RunProcessParams
:param async_req: Whether to execute the request asynchronously.
@@ -983,6 +1143,7 @@ class DefaultApi(object):
_all_params = [
'id',
+ 'wait',
'run_process_params'
]
_all_params.extend(
@@ -1002,7 +1163,7 @@ class DefaultApi(object):
if _key not in _all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
- " to method run_process" % _key
+ " to method start_process" % _key
)
_params[_key] = _val
del _params['kwargs']
@@ -1016,6 +1177,8 @@ class DefaultApi(object):
# process the query parameters
_query_params = []
+ if _params.get('wait') is not None: # noqa: E501
+ _query_params.append(('wait', _params['wait']))
# process the header parameters
_header_params = dict(_params.get('_headers', {}))
@@ -1064,6 +1227,148 @@ class DefaultApi(object):
collection_formats=_collection_formats,
_request_auth=_params.get('_request_auth'))
+ @validate_arguments
+ def stop_process(self, id : StrictStr, process_id : StrictStr, **kwargs) -> None: # noqa: E501
+ """stop_process # noqa: E501
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+
+ >>> thread = api.stop_process(id, process_id, async_req=True)
+ >>> result = thread.get()
+
+ :param id: (required)
+ :type id: str
+ :param process_id: (required)
+ :type process_id: str
+ :param async_req: Whether to execute the request asynchronously.
+ :type async_req: bool, optional
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
+ be returned without reading/decoding response
+ data. Default is True.
+ :type _preload_content: bool, optional
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :return: Returns the result object.
+ If the method is called asynchronously,
+ returns the request thread.
+ :rtype: None
+ """
+ kwargs['_return_http_data_only'] = True
+ return self.stop_process_with_http_info(id, process_id, **kwargs) # noqa: E501
+
+ @validate_arguments
+ def stop_process_with_http_info(self, id : StrictStr, process_id : StrictStr, **kwargs): # noqa: E501
+ """stop_process # noqa: E501
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+
+ >>> thread = api.stop_process_with_http_info(id, process_id, async_req=True)
+ >>> result = thread.get()
+
+ :param id: (required)
+ :type id: str
+ :param process_id: (required)
+ :type process_id: str
+ :param async_req: Whether to execute the request asynchronously.
+ :type async_req: bool, optional
+ :param _return_http_data_only: response data without head status code
+ and headers
+ :type _return_http_data_only: bool, optional
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
+ be returned without reading/decoding response
+ data. Default is True.
+ :type _preload_content: bool, optional
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the authentication
+ in the spec for a single request.
+ :type _request_auth: dict, optional
+ :type _content_type: string, optional: force content-type for the request
+ :return: Returns the result object.
+ If the method is called asynchronously,
+ returns the request thread.
+ :rtype: None
+ """
+
+ _params = locals()
+
+ _all_params = [
+ 'id',
+ 'process_id'
+ ]
+ _all_params.extend(
+ [
+ 'async_req',
+ '_return_http_data_only',
+ '_preload_content',
+ '_request_timeout',
+ '_request_auth',
+ '_content_type',
+ '_headers'
+ ]
+ )
+
+ # validate the arguments
+ for _key, _val in _params['kwargs'].items():
+ if _key not in _all_params:
+ raise ApiTypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method stop_process" % _key
+ )
+ _params[_key] = _val
+ del _params['kwargs']
+
+ _collection_formats = {}
+
+ # process the path parameters
+ _path_params = {}
+ if _params['id']:
+ _path_params['id'] = _params['id']
+ if _params['process_id']:
+ _path_params['processID'] = _params['process_id']
+
+ # process the query parameters
+ _query_params = []
+
+ # process the header parameters
+ _header_params = dict(_params.get('_headers', {}))
+
+ # process the form parameters
+ _form_params = []
+ _files = {}
+
+ # process the body parameter
+ _body_params = None
+
+ # authentication setting
+ _auth_settings = [] # noqa: E501
+
+ _response_types_map = {}
+
+ return self.api_client.call_api(
+ '/sessions/{id}/process/{processID}', 'DELETE',
+ _path_params,
+ _query_params,
+ _header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ response_types_map=_response_types_map,
+ auth_settings=_auth_settings,
+ async_req=_params.get('async_req'),
+ _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
+ _preload_content=_params.get('_preload_content', True),
+ _request_timeout=_params.get('_request_timeout'),
+ collection_formats=_collection_formats,
+ _request_auth=_params.get('_request_auth'))
+
@validate_arguments
def write_filesystem_file(self, id : StrictStr, path : StrictStr, write_filesystem_file_request : WriteFilesystemFileRequest, **kwargs) -> None: # noqa: E501
"""write_filesystem_file # noqa: E501
@@ -1219,3 +1524,159 @@ class DefaultApi(object):
_request_timeout=_params.get('_request_timeout'),
collection_formats=_collection_formats,
_request_auth=_params.get('_request_auth'))
+
+ @validate_arguments
+ def write_process_stdin(self, id : StrictStr, process_id : StrictStr, write_process_stdin_request : WriteProcessStdinRequest, **kwargs) -> None: # noqa: E501
+ """write_process_stdin # noqa: E501
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+
+ >>> thread = api.write_process_stdin(id, process_id, write_process_stdin_request, async_req=True)
+ >>> result = thread.get()
+
+ :param id: (required)
+ :type id: str
+ :param process_id: (required)
+ :type process_id: str
+ :param write_process_stdin_request: (required)
+ :type write_process_stdin_request: WriteProcessStdinRequest
+ :param async_req: Whether to execute the request asynchronously.
+ :type async_req: bool, optional
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
+ be returned without reading/decoding response
+ data. Default is True.
+ :type _preload_content: bool, optional
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :return: Returns the result object.
+ If the method is called asynchronously,
+ returns the request thread.
+ :rtype: None
+ """
+ kwargs['_return_http_data_only'] = True
+ return self.write_process_stdin_with_http_info(id, process_id, write_process_stdin_request, **kwargs) # noqa: E501
+
+ @validate_arguments
+ def write_process_stdin_with_http_info(self, id : StrictStr, process_id : StrictStr, write_process_stdin_request : WriteProcessStdinRequest, **kwargs): # noqa: E501
+ """write_process_stdin # noqa: E501
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+
+ >>> thread = api.write_process_stdin_with_http_info(id, process_id, write_process_stdin_request, async_req=True)
+ >>> result = thread.get()
+
+ :param id: (required)
+ :type id: str
+ :param process_id: (required)
+ :type process_id: str
+ :param write_process_stdin_request: (required)
+ :type write_process_stdin_request: WriteProcessStdinRequest
+ :param async_req: Whether to execute the request asynchronously.
+ :type async_req: bool, optional
+ :param _return_http_data_only: response data without head status code
+ and headers
+ :type _return_http_data_only: bool, optional
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
+ be returned without reading/decoding response
+ data. Default is True.
+ :type _preload_content: bool, optional
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :param _request_auth: set to override the auth_settings for an a single
+ request; this effectively ignores the authentication
+ in the spec for a single request.
+ :type _request_auth: dict, optional
+ :type _content_type: string, optional: force content-type for the request
+ :return: Returns the result object.
+ If the method is called asynchronously,
+ returns the request thread.
+ :rtype: None
+ """
+
+ _params = locals()
+
+ _all_params = [
+ 'id',
+ 'process_id',
+ 'write_process_stdin_request'
+ ]
+ _all_params.extend(
+ [
+ 'async_req',
+ '_return_http_data_only',
+ '_preload_content',
+ '_request_timeout',
+ '_request_auth',
+ '_content_type',
+ '_headers'
+ ]
+ )
+
+ # validate the arguments
+ for _key, _val in _params['kwargs'].items():
+ if _key not in _all_params:
+ raise ApiTypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method write_process_stdin" % _key
+ )
+ _params[_key] = _val
+ del _params['kwargs']
+
+ _collection_formats = {}
+
+ # process the path parameters
+ _path_params = {}
+ if _params['id']:
+ _path_params['id'] = _params['id']
+ if _params['process_id']:
+ _path_params['processID'] = _params['process_id']
+
+ # process the query parameters
+ _query_params = []
+
+ # process the header parameters
+ _header_params = dict(_params.get('_headers', {}))
+
+ # process the form parameters
+ _form_params = []
+ _files = {}
+
+ # process the body parameter
+ _body_params = None
+ if _params['write_process_stdin_request']:
+ _body_params = _params['write_process_stdin_request']
+
+ # set the HTTP header `Content-Type`
+ _content_types_list = _params.get('_content_type',
+ self.api_client.select_header_content_type(
+ ['application/json']))
+ if _content_types_list:
+ _header_params['Content-Type'] = _content_types_list
+
+ # authentication setting
+ _auth_settings = [] # noqa: E501
+
+ _response_types_map = {}
+
+ return self.api_client.call_api(
+ '/sessions/{id}/process/{processID}/stdin', 'POST',
+ _path_params,
+ _query_params,
+ _header_params,
+ body=_body_params,
+ post_params=_form_params,
+ files=_files,
+ response_types_map=_response_types_map,
+ auth_settings=_auth_settings,
+ async_req=_params.get('async_req'),
+ _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
+ _preload_content=_params.get('_preload_content', True),
+ _request_timeout=_params.get('_request_timeout'),
+ collection_formats=_collection_formats,
+ _request_auth=_params.get('_request_auth'))
diff --git a/api-service/playground_client/docs/DefaultApi.md b/api-service/playground_client/docs/DefaultApi.md
index 4317a4d72..7793fdbc4 100644
--- a/api-service/playground_client/docs/DefaultApi.md
+++ b/api-service/playground_client/docs/DefaultApi.md
@@ -7,11 +7,14 @@ Method | HTTP request | Description
[**create_sessions**](DefaultApi.md#create_sessions) | **POST** /sessions |
[**delete_filesystem_entry**](DefaultApi.md#delete_filesystem_entry) | **DELETE** /sessions/{id}/filesystem |
[**delete_session**](DefaultApi.md#delete_session) | **DELETE** /sessions/{id} |
+[**get_process**](DefaultApi.md#get_process) | **GET** /sessions/{id}/process/{processID} |
[**list_filesystem_dir**](DefaultApi.md#list_filesystem_dir) | **GET** /sessions/{id}/filesystem/dir |
[**make_filesystem_dir**](DefaultApi.md#make_filesystem_dir) | **PUT** /sessions/{id}/filesystem/dir |
[**read_filesystem_file**](DefaultApi.md#read_filesystem_file) | **GET** /sessions/{id}/filesystem/file |
-[**run_process**](DefaultApi.md#run_process) | **POST** /sessions/{id}/process |
+[**start_process**](DefaultApi.md#start_process) | **POST** /sessions/{id}/process |
+[**stop_process**](DefaultApi.md#stop_process) | **DELETE** /sessions/{id}/process/{processID} |
[**write_filesystem_file**](DefaultApi.md#write_filesystem_file) | **PUT** /sessions/{id}/filesystem/file |
+[**write_process_stdin**](DefaultApi.md#write_process_stdin) | **POST** /sessions/{id}/process/{processID}/stdin |
# **create_sessions**
@@ -195,6 +198,71 @@ No authorization required
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+# **get_process**
+> RunProcessResponse get_process(id, process_id, wait)
+
+
+
+### Example
+
+```python
+from __future__ import print_function
+import time
+import os
+import playground_client
+from playground_client.rest import ApiException
+from pprint import pprint
+# Defining the host is optional and defaults to https://localhost:9001
+# See configuration.py for a list of all supported configuration parameters.
+configuration = playground_client.Configuration(
+ host = "https://localhost:9001"
+)
+
+
+# Enter a context with an instance of the API client
+with playground_client.ApiClient(configuration) as api_client:
+ # Create an instance of the API class
+ api_instance = playground_client.DefaultApi(api_client)
+ id = 'id_example' # str |
+ process_id = 'process_id_example' # str |
+ wait = True # bool |
+
+ try:
+ api_response = api_instance.get_process(id, process_id, wait)
+ print("The response of DefaultApi->get_process:\n")
+ pprint(api_response)
+ except Exception as e:
+ print("Exception when calling DefaultApi->get_process: %s\n" % e)
+```
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **str**| |
+ **process_id** | **str**| |
+ **wait** | **bool**| |
+
+### Return type
+
+[**RunProcessResponse**](RunProcessResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Ok | - |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
# **list_filesystem_dir**
> ListFilesystemDirResponse list_filesystem_dir(id, path)
@@ -382,8 +450,8 @@ No authorization required
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-# **run_process**
-> RunProcessResponse run_process(id, run_process_params)
+# **start_process**
+> RunProcessResponse start_process(id, wait, run_process_params)
@@ -408,14 +476,15 @@ with playground_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = playground_client.DefaultApi(api_client)
id = 'id_example' # str |
+ wait = True # bool |
run_process_params = playground_client.RunProcessParams() # RunProcessParams |
try:
- api_response = api_instance.run_process(id, run_process_params)
- print("The response of DefaultApi->run_process:\n")
+ api_response = api_instance.start_process(id, wait, run_process_params)
+ print("The response of DefaultApi->start_process:\n")
pprint(api_response)
except Exception as e:
- print("Exception when calling DefaultApi->run_process: %s\n" % e)
+ print("Exception when calling DefaultApi->start_process: %s\n" % e)
```
### Parameters
@@ -423,6 +492,7 @@ with playground_client.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| |
+ **wait** | **bool**| |
**run_process_params** | [**RunProcessParams**](RunProcessParams.md)| |
### Return type
@@ -445,6 +515,67 @@ No authorization required
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+# **stop_process**
+> stop_process(id, process_id)
+
+
+
+### Example
+
+```python
+from __future__ import print_function
+import time
+import os
+import playground_client
+from playground_client.rest import ApiException
+from pprint import pprint
+# Defining the host is optional and defaults to https://localhost:9001
+# See configuration.py for a list of all supported configuration parameters.
+configuration = playground_client.Configuration(
+ host = "https://localhost:9001"
+)
+
+
+# Enter a context with an instance of the API client
+with playground_client.ApiClient(configuration) as api_client:
+ # Create an instance of the API class
+ api_instance = playground_client.DefaultApi(api_client)
+ id = 'id_example' # str |
+ process_id = 'process_id_example' # str |
+
+ try:
+ api_instance.stop_process(id, process_id)
+ except Exception as e:
+ print("Exception when calling DefaultApi->stop_process: %s\n" % e)
+```
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **str**| |
+ **process_id** | **str**| |
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | No content | - |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
# **write_filesystem_file**
> write_filesystem_file(id, path, write_filesystem_file_request)
@@ -508,3 +639,66 @@ No authorization required
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+# **write_process_stdin**
+> write_process_stdin(id, process_id, write_process_stdin_request)
+
+
+
+### Example
+
+```python
+from __future__ import print_function
+import time
+import os
+import playground_client
+from playground_client.rest import ApiException
+from pprint import pprint
+# Defining the host is optional and defaults to https://localhost:9001
+# See configuration.py for a list of all supported configuration parameters.
+configuration = playground_client.Configuration(
+ host = "https://localhost:9001"
+)
+
+
+# Enter a context with an instance of the API client
+with playground_client.ApiClient(configuration) as api_client:
+ # Create an instance of the API class
+ api_instance = playground_client.DefaultApi(api_client)
+ id = 'id_example' # str |
+ process_id = 'process_id_example' # str |
+ write_process_stdin_request = playground_client.WriteProcessStdinRequest() # WriteProcessStdinRequest |
+
+ try:
+ api_instance.write_process_stdin(id, process_id, write_process_stdin_request)
+ except Exception as e:
+ print("Exception when calling DefaultApi->write_process_stdin: %s\n" % e)
+```
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **str**| |
+ **process_id** | **str**| |
+ **write_process_stdin_request** | [**WriteProcessStdinRequest**](WriteProcessStdinRequest.md)| |
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | No content | - |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
diff --git a/api-service/playground_client/docs/RunProcessResponse.md b/api-service/playground_client/docs/RunProcessResponse.md
index 40843e883..d26acfb78 100644
--- a/api-service/playground_client/docs/RunProcessResponse.md
+++ b/api-service/playground_client/docs/RunProcessResponse.md
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**stderr** | [**List[OutStderrResponse]**](OutStderrResponse.md) | |
**stdout** | [**List[OutStdoutResponse]**](OutStdoutResponse.md) | |
+**process_id** | **str** | |
## Example
diff --git a/api-service/playground_client/docs/WriteProcessStdinRequest.md b/api-service/playground_client/docs/WriteProcessStdinRequest.md
new file mode 100644
index 000000000..541701d64
--- /dev/null
+++ b/api-service/playground_client/docs/WriteProcessStdinRequest.md
@@ -0,0 +1,28 @@
+# WriteProcessStdinRequest
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**stdin** | **str** | |
+
+## Example
+
+```python
+from playground_client.models.write_process_stdin_request import WriteProcessStdinRequest
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of WriteProcessStdinRequest from a JSON string
+write_process_stdin_request_instance = WriteProcessStdinRequest.from_json(json)
+# print the JSON string representation of the object
+print WriteProcessStdinRequest.to_json()
+
+# convert the object into a dict
+write_process_stdin_request_dict = write_process_stdin_request_instance.to_dict()
+# create an instance of WriteProcessStdinRequest from a dict
+write_process_stdin_request_form_dict = write_process_stdin_request.from_dict(write_process_stdin_request_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/api-service/playground_client/models/__init__.py b/api-service/playground_client/models/__init__.py
index 8138b0463..46521afb2 100644
--- a/api-service/playground_client/models/__init__.py
+++ b/api-service/playground_client/models/__init__.py
@@ -27,3 +27,4 @@ from playground_client.models.read_filesystem_file_response import ReadFilesyste
from playground_client.models.run_process_params import RunProcessParams
from playground_client.models.run_process_response import RunProcessResponse
from playground_client.models.write_filesystem_file_request import WriteFilesystemFileRequest
+from playground_client.models.write_process_stdin_request import WriteProcessStdinRequest
diff --git a/api-service/playground_client/models/run_process_response.py b/api-service/playground_client/models/run_process_response.py
index d9f8e7e68..2ff2262fc 100644
--- a/api-service/playground_client/models/run_process_response.py
+++ b/api-service/playground_client/models/run_process_response.py
@@ -18,7 +18,7 @@ import json
from typing import List
-from pydantic import BaseModel
+from pydantic import BaseModel, Field, StrictStr
from playground_client.models.out_stderr_response import OutStderrResponse
from playground_client.models.out_stdout_response import OutStdoutResponse
@@ -30,7 +30,8 @@ class RunProcessResponse(BaseModel):
"""
stderr: List[OutStderrResponse] = ...
stdout: List[OutStdoutResponse] = ...
- __properties = ["stderr", "stdout"]
+ process_id: StrictStr = Field(..., alias="processID")
+ __properties = ["stderr", "stdout", "processID"]
class Config:
allow_population_by_field_name = True
@@ -87,7 +88,8 @@ class RunProcessResponse(BaseModel):
_obj = RunProcessResponse.parse_obj({
"stderr": [OutStderrResponse.from_dict(_item) for _item in obj.get("stderr")] if obj.get("stderr") is not None else None,
- "stdout": [OutStdoutResponse.from_dict(_item) for _item in obj.get("stdout")] if obj.get("stdout") is not None else None
+ "stdout": [OutStdoutResponse.from_dict(_item) for _item in obj.get("stdout")] if obj.get("stdout") is not None else None,
+ "process_id": obj.get("processID")
})
return _obj
diff --git a/api-service/playground_client/models/write_process_stdin_request.py b/api-service/playground_client/models/write_process_stdin_request.py
new file mode 100644
index 000000000..7f8aefbae
--- /dev/null
+++ b/api-service/playground_client/models/write_process_stdin_request.py
@@ -0,0 +1,82 @@
+# coding: utf-8
+
+"""
+ playground
+
+ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
+
+ The version of the OpenAPI document: 1.0.0
+ Generated by: https://openapi-generator.tech
+"""
+
+
+from __future__ import annotations
+from inspect import getfullargspec
+import pprint
+import re # noqa: F401
+import json
+
+
+
+from pydantic import BaseModel, StrictStr
+
+class WriteProcessStdinRequest(BaseModel):
+ """NOTE: This class is auto generated by OpenAPI Generator.
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+ stdin: StrictStr = ...
+ additional_properties: Dict[str, Any] = {}
+ __properties = ["stdin"]
+
+ class Config:
+ allow_population_by_field_name = True
+ validate_assignment = True
+
+ def to_str(self) -> str:
+ """Returns the string representation of the model using alias"""
+ return pprint.pformat(self.dict(by_alias=True))
+
+ def to_json(self) -> str:
+ """Returns the JSON representation of the model using alias"""
+ return json.dumps(self.to_dict())
+
+ @classmethod
+ def from_json(cls, json_str: str) -> WriteProcessStdinRequest:
+ """Create an instance of WriteProcessStdinRequest from a JSON string"""
+ return cls.from_dict(json.loads(json_str))
+
+ def to_dict(self):
+ """Returns the dictionary representation of the model using alias"""
+ _dict = self.dict(by_alias=True,
+ exclude={
+ "additional_properties"
+ },
+ exclude_none=True)
+ # puts key-value pairs in additional_properties in the top level
+ if self.additional_properties is not None:
+ for _key, _value in self.additional_properties.items():
+ _dict[_key] = _value
+
+ return _dict
+
+ @classmethod
+ def from_dict(cls, obj: dict) -> WriteProcessStdinRequest:
+ """Create an instance of WriteProcessStdinRequest from a dict"""
+ if obj is None:
+ return None
+
+ if type(obj) is not dict:
+ return WriteProcessStdinRequest.parse_obj(obj)
+
+ _obj = WriteProcessStdinRequest.parse_obj({
+ "stdin": obj.get("stdin")
+ })
+ # store additional fields in additional_properties
+ for _key in obj.keys():
+ if _key not in cls.__properties:
+ _obj.additional_properties[_key] = obj.get(_key)
+
+ return _obj
+
diff --git a/api-service/playground_client/test/test_default_api.py b/api-service/playground_client/test/test_default_api.py
index 4cf7745ef..d082bb255 100644
--- a/api-service/playground_client/test/test_default_api.py
+++ b/api-service/playground_client/test/test_default_api.py
@@ -46,6 +46,12 @@ class TestDefaultApi(unittest.TestCase):
"""
pass
+ def test_get_process(self):
+ """Test case for get_process
+
+ """
+ pass
+
def test_list_filesystem_dir(self):
"""Test case for list_filesystem_dir
@@ -64,8 +70,14 @@ class TestDefaultApi(unittest.TestCase):
"""
pass
- def test_run_process(self):
- """Test case for run_process
+ def test_start_process(self):
+ """Test case for start_process
+
+ """
+ pass
+
+ def test_stop_process(self):
+ """Test case for stop_process
"""
pass
@@ -76,6 +88,12 @@ class TestDefaultApi(unittest.TestCase):
"""
pass
+ def test_write_process_stdin(self):
+ """Test case for write_process_stdin
+
+ """
+ pass
+
if __name__ == '__main__':
unittest.main()
diff --git a/api-service/playground_client/test/test_run_process_response.py b/api-service/playground_client/test/test_run_process_response.py
index 2a50e0ac2..40b9f24a1 100644
--- a/api-service/playground_client/test/test_run_process_response.py
+++ b/api-service/playground_client/test/test_run_process_response.py
@@ -49,7 +49,8 @@ class TestRunProcessResponse(unittest.TestCase):
type = 'Stdout',
timestamp = 1.337,
line = '', )
- ]
+ ],
+ process_id = ''
)
else :
return RunProcessResponse(
@@ -65,6 +66,7 @@ class TestRunProcessResponse(unittest.TestCase):
timestamp = 1.337,
line = '', )
],
+ process_id = '',
)
"""
diff --git a/api-service/playground_client/test/test_write_process_stdin_request.py b/api-service/playground_client/test/test_write_process_stdin_request.py
new file mode 100644
index 000000000..73ed18b4a
--- /dev/null
+++ b/api-service/playground_client/test/test_write_process_stdin_request.py
@@ -0,0 +1,55 @@
+# coding: utf-8
+
+"""
+ playground
+
+ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
+
+ The version of the OpenAPI document: 1.0.0
+ Generated by: https://openapi-generator.tech
+"""
+
+
+from __future__ import absolute_import
+
+import unittest
+import datetime
+
+import playground_client
+from playground_client.models.write_process_stdin_request import WriteProcessStdinRequest # noqa: E501
+from playground_client.rest import ApiException
+
+class TestWriteProcessStdinRequest(unittest.TestCase):
+ """WriteProcessStdinRequest unit test stubs"""
+
+ def setUp(self):
+ pass
+
+ def tearDown(self):
+ pass
+
+ def make_instance(self, include_optional):
+ """Test WriteProcessStdinRequest
+ include_option is a boolean, when False only required
+ params are included, when True both required and
+ optional params are included """
+ # uncomment below to create an instance of `WriteProcessStdinRequest`
+ """
+ model = playground_client.models.write_process_stdin_request.WriteProcessStdinRequest() # noqa: E501
+ if include_optional :
+ return WriteProcessStdinRequest(
+ stdin = ''
+ )
+ else :
+ return WriteProcessStdinRequest(
+ stdin = '',
+ )
+ """
+
+ def testWriteProcessStdinRequest(self):
+ """Test WriteProcessStdinRequest"""
+ # inst_req_only = self.make_instance(include_optional=False)
+ # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+ unittest.main()
diff --git a/api-service/playground_client_README.md b/api-service/playground_client_README.md
index 0845f990c..353f10cf6 100644
--- a/api-service/playground_client_README.md
+++ b/api-service/playground_client_README.md
@@ -67,11 +67,14 @@ Class | Method | HTTP request | Description
*DefaultApi* | [**create_sessions**](playground_client/docs/DefaultApi.md#create_sessions) | **POST** /sessions |
*DefaultApi* | [**delete_filesystem_entry**](playground_client/docs/DefaultApi.md#delete_filesystem_entry) | **DELETE** /sessions/{id}/filesystem |
*DefaultApi* | [**delete_session**](playground_client/docs/DefaultApi.md#delete_session) | **DELETE** /sessions/{id} |
+*DefaultApi* | [**get_process**](playground_client/docs/DefaultApi.md#get_process) | **GET** /sessions/{id}/process/{processID} |
*DefaultApi* | [**list_filesystem_dir**](playground_client/docs/DefaultApi.md#list_filesystem_dir) | **GET** /sessions/{id}/filesystem/dir |
*DefaultApi* | [**make_filesystem_dir**](playground_client/docs/DefaultApi.md#make_filesystem_dir) | **PUT** /sessions/{id}/filesystem/dir |
*DefaultApi* | [**read_filesystem_file**](playground_client/docs/DefaultApi.md#read_filesystem_file) | **GET** /sessions/{id}/filesystem/file |
-*DefaultApi* | [**run_process**](playground_client/docs/DefaultApi.md#run_process) | **POST** /sessions/{id}/process |
+*DefaultApi* | [**start_process**](playground_client/docs/DefaultApi.md#start_process) | **POST** /sessions/{id}/process |
+*DefaultApi* | [**stop_process**](playground_client/docs/DefaultApi.md#stop_process) | **DELETE** /sessions/{id}/process/{processID} |
*DefaultApi* | [**write_filesystem_file**](playground_client/docs/DefaultApi.md#write_filesystem_file) | **PUT** /sessions/{id}/filesystem/file |
+*DefaultApi* | [**write_process_stdin**](playground_client/docs/DefaultApi.md#write_process_stdin) | **POST** /sessions/{id}/process/{processID}/stdin |
## Documentation For Models
@@ -89,6 +92,7 @@ Class | Method | HTTP request | Description
- [RunProcessParams](playground_client/docs/RunProcessParams.md)
- [RunProcessResponse](playground_client/docs/RunProcessResponse.md)
- [WriteFilesystemFileRequest](playground_client/docs/WriteFilesystemFileRequest.md)
+ - [WriteProcessStdinRequest](playground_client/docs/WriteProcessStdinRequest.md)
## Documentation For Authorization