Mercurial > sci

annotate doc/api.md @ 12:be3ec0e6bb8f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
scid: remove status from jobresult
author David Demelier <markand@malikania.fr>
date Tue, 29 Jun 2021 21:24:16 +0200
parents 5fa3d2f479b2
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 # Network REST API
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 This document describes the network API for access through the `scid` program
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 from `sciworker`.
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 # Base definitions
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 The API is versioned and starts with the `/api/v?` where the question mark is
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 replaced with the current version.
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 # API v1
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 ## (GET) /jobs/<w>
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 Get the jobs pending that the worker `w` is supposed to run.
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 Request:
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 No data.
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
20
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 Response:
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
22
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 ```
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 [
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 {
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 "project": "foobar",
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 "tag": "1234"
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 }
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 ]
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 ```
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
31
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 ## (POST) /jobs/<w>
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
33
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 Post the result of the a job from the worker `w`.
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
35
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 Request:
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
37
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 ```
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 {
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 "project": "foobar",
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 "tag": 1234",
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 "output": "stdout/stderr combined"
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 }
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
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 ```