api.md

JobProxy

Overview

JobProxy REST API for running task independent of the framework

Version information

Version : 0.1.0.beta.1.10

License information

License : Apache 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0.html
Terms of service : https://github.com/BiBiServ/jobproxy

Paths

Delete a Task.

DELETE /v1/jobproxy/delete/{id}

Description

Delete a Task.

Parameters

Type	Name	Schema
Path	id required	string

Responses

HTTP Code	Description	Schema
default	successful operation	No Content

Just a simple ping command.

GET /v1/jobproxy/ping

Description

Just a simple ping command.

Responses

HTTP Code	Description	Schema
200	successful operation	string

Produces

• text/plain

Returns the state of all tasks.

GET /v1/jobproxy/state

Description

Returns the state of all tasks in machine readable format (either xml or json * depending on request-header mime-type)

Responses

HTTP Code	Description	Schema
200	successful operation	States

Produces

• application/json
• application/xml

Returns the state of one task.

GET /v1/jobproxy/state/{id}

Description

Returns the state of one task with given id in machine readable format. * (either xml or json depending on request-header mime-type)

Parameters

Type	Name	Schema
Path	id required	string

Responses

HTTP Code	Description	Schema
200	successful operation	State

Produces

• application/json
• application/xml

Submit a task

POST /v1/jobproxy/submit

Description

Submit a task

Parameters

Type	Name	Schema
Body	task optional	Task

Responses

HTTP Code	Description	Schema
200	successful operation	string

Consumes

• application/json
• application/xml

Produces

• text/plain

Definitions

Mount

Name	Description	Schema
container required	Length : 1 - 2147483647	string
host required	Length : 1 - 2147483647	string
mode required	Length : 1 - 2147483647	string

Port

Name	Schema
container optional	integer (int32)
host optional	integer (int32)

State

Name	Schema
code required	string
description optional	string
id required	string
stderr optional	string
stdout optional	string

States

Name	Schema
state optional	< State > array

TContainer

Name	Description	Schema
image required	Length : 1 - 2147483647	string
mounts optional		< TMounts > array
ports optional		< TPorts > array

TMounts

Name	Schema
mount required	Mount

TPorts

Name	Schema
port required	Port

Task

Name	Description	Schema
cmd optional		< string > array
container optional		TContainer
cores optional		integer (int32)
cputime optional		integer (int32)
memory optional		integer (int32)
stderr optional		string
stdout optional		string
user required	Length : 1 - 2147483647	string