From c805451c118f5863bc48fe684c2e5a33ba5af703 Mon Sep 17 00:00:00 2001 From: Brian Seymour Date: Thu, 22 Apr 2021 21:39:44 -0500 Subject: [PATCH] updated readme --- readme.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/readme.md b/readme.md index ea764b1..57aad50 100644 --- a/readme.md +++ b/readme.md @@ -207,12 +207,12 @@ This endpoint requests execution of some arbitrary code. - `language` (**required**) The language to use for execution, must be a string and must be installed. - `version` (**required**) The version of the language to use for execution, must be a string containing a SemVer selector for the version or the specific version number to use. - `files` (**required**) An array of files containing code or other data that should be used for execution. The first file in this array is considered the main file. -- `files[].name` (**optinal**) The name of the file to upload, must be a string containing no path. +- `files[].name` (*optional*) The name of the file to upload, must be a string containing no path or left out. - `files[].content` (**required**) The content of the files to upload, must be a string containing text to write. -- `stdin` (*optional*) The text to pass as stdin to the program. Must be a string, can be left blank. -- `args` (*optional*) The arguments to pass to the program. Must be an array. -- `compile_timeout` (*optional*) The maximum time allowed for the compile stage to finish before bailing out in milliseconds. Must be a number. -- `run_timeout` (*optional*) The maximum time allowed for the run stage to finish before bailing out in milliseconds. Must be a number. +- `stdin` (*optional*) The text to pass as stdin to the program. Must be a string or left out. Defaults to blank string. +- `args` (*optional*) The arguments to pass to the program. Must be an array or left out. Defaults to `[]`. +- `compile_timeout` (*optional*) The maximum time allowed for the compile stage to finish before bailing out in milliseconds. Must be a number or left out. Defaults to `10000` (10 seconds). +- `run_timeout` (*optional*) The maximum time allowed for the run stage to finish before bailing out in milliseconds. Must be a number or left out. Defaults to `3000` (3 seconds). ```json { @@ -220,7 +220,6 @@ This endpoint requests execution of some arbitrary code. "version": "15.10.0", "files": [ { - "main": true, "name": "my_cool_code.js", "content": "console.log(process.argv)" }