Mercurial > sci
annotate doc/api.md @ 9:3ef8128e244f
sci: add project-update command
author | David Demelier <markand@malikania.fr> |
---|---|
date | Wed, 23 Jun 2021 14:05:36 +0200 |
parents | 5fa3d2f479b2 |
children |
rev | line source |
---|---|
0 | 1 # Network REST API |
2 | |
3 This document describes the network API for access through the `scid` program | |
4 from `sciworker`. | |
5 | |
6 # Base definitions | |
7 | |
8 The API is versioned and starts with the `/api/v?` where the question mark is | |
9 replaced with the current version. | |
10 | |
11 # API v1 | |
12 | |
13 ## (GET) /jobs/<w> | |
14 | |
15 Get the jobs pending that the worker `w` is supposed to run. | |
16 | |
17 Request: | |
18 | |
19 No data. | |
20 | |
21 Response: | |
22 | |
23 ``` | |
24 [ | |
25 { | |
26 "project": "foobar", | |
27 "tag": "1234" | |
28 } | |
29 ] | |
30 ``` | |
31 | |
32 ## (POST) /jobs/<w> | |
33 | |
34 Post the result of the a job from the worker `w`. | |
35 | |
36 Request: | |
37 | |
38 ``` | |
39 { | |
40 "project": "foobar", | |
41 "tag": 1234", | |
42 "output": "stdout/stderr combined" | |
43 } | |
44 ``` | |
2
5fa3d2f479b2
sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
45 |
5fa3d2f479b2
sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
46 ### (GET) /script/<p> |
5fa3d2f479b2
sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
47 |
5fa3d2f479b2
sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
48 Get script code for project `p`. |
5fa3d2f479b2
sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
49 |
5fa3d2f479b2
sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
50 Request: |
5fa3d2f479b2
sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
51 |
5fa3d2f479b2
sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
52 No data. |
5fa3d2f479b2
sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
53 |
5fa3d2f479b2
sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
54 Reponse: |
5fa3d2f479b2
sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
55 |
5fa3d2f479b2
sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
56 ``` |
5fa3d2f479b2
sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
57 { |
5fa3d2f479b2
sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
58 "code": "#!/bin/sh exit 0" |
5fa3d2f479b2
sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
59 } |
5fa3d2f479b2
sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
60 ``` |