compose API documentation version v1
localhost/{version}
- version: required(v1)
/compose
Composes a zipped source directory into a single file
post
post /compose
Query Parameters
- file: required(file)
A zip archive of a source code directory
- language: required(string)
lowercase common name of programming language used in zip archive
Example:
javascript or python - entry: required(string)
full path to entry file from the root of the zip archive
- out: (string)
name without extension to return file as, if not provided a random id is used.
HTTP status code 200
Body
Media type: application/zip
Type: file
HTTP status code 400
Body
Media type: application/json
Type: string
Example:
{
"message": "helpful message, usually unset required parameter",
"hint": "hint to correct input if possible",
"status": "400"
}
HTTP status code 404
Body
Media type: application/json
Type: string
Example:
{
"message": "Entry file <filename> not found in zip",
"hint": "No suggestions | Maybe one of [list of suggestions] | Maybe this <path/filename>",
"status": "404"
}
HTTP status code 501
Body
Media type: application/json
Type: string
Example:
{
"message": "<language> is not implemented",
"hint": "implemented languages are [list of implemented langauges]",
"status": "501"
}
/revert
Reverts a composed file to its directory structure
post
post /revert
Query Parameters
- file: required(file)
single source file
- language: required(string)
common name of programming language used in single source file
Example:
javascript or python - out: (string)
name without extension to return file as, if not provided a random id is used.