This repository has been archived by the owner on May 19, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathdoc-api-swagger.yml
208 lines (202 loc) · 7.04 KB
/
doc-api-swagger.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
swagger: '2.0'
info:
version: 0.0.1
title: Eae-compute
license:
name: MIT
url: https://github.com/dsi-icl/eae-compute/blob/master/LICENSE
description: eAE Compute
paths:
/status:
get:
description: Status report. Part of the standard API for all the eae components
responses:
200:
description: Status report is active, replies the current status
schema:
type: object
description: Status report
properties:
status:
type: string
description: MUST be oneof EAE_SERVICE_STATUS_XXX
/specs:
get:
description: Detailed status report. Part of the standard API for eae components
responses:
200:
description: desc
schema:
$ref: '#definitions/statusModel'
/run/{job_id}:
parameters:
- name: job_id
type: string
in: path
required: true
description: Unique identifier of the job to run
post:
description: Starts the execution of a job
responses:
200:
description: The job is being executed
schema:
type: object
properties:
status:
type: string
description: Job status, MUST be oneof EAE_JOB_STATUS_XXX
401:
description: Missing or unknown job_id
schema:
type: object
description: Eae ErrorStack tracking the error origin
503:
description: The service is already busy
schema:
type: object
description: Eae ErrorStack
/cancel:
post:
description: Cancels current task
responses:
200:
description: Job has been interrupted
schema:
type: object
properties:
status:
type: string
description: New status of canceled job
501:
description: Nothing to cancel
schema:
type: object
description: eAE ErrorStack with meaningful information
500:
description: Fail to interrupt job
schema:
type: object
description: eAE ErrorStack tracking the error origin
definitions:
statusModel:
description: Model to represent a service status
properties:
type:
type: string
description: Type of the eae service
status:
type: string
description: Current status of the service. Defaults to 'eae_service_idle'
statusLock:
type: boolean
description: Lock used to prevent the service status update
lastUpdate:
type: string
format: dateTime
description: Timestamp of the last update of this model
port:
type: integer
description: TCP Port the service is listening on
ip:
type: string
description: IPv4 address of the machine
hostname:
type: string
description: Domain name associated with this machine
system:
type: object
description: Hardware speciciafations
properties:
arch:
type: string
description: System architecture label
type:
type: string
description: System type label
platform:
type: string
description: Operating system name
version:
type: string
description: Operation system version number
cpu:
type: object
description: Information about the cpu
properties:
cores:
type: array
items:
type: object
description: A single core properties list
loadavg:
type: array
description: The load average for the last 1, 5 and 15 minutes
items:
type: number
memory:
type: object
description: Information about the memory
properties:
total:
type: string
description: Total memory on the system. Unit is provided in the value
free:
type: string
description: Available memory on the system. Unit is provided in the value
jobModel:
type: object
properties:
id:
type: string
description: Unique identifier
type:
type: string
description: Job type definition, MUST be oneof EAE_JOB_TYPE_XXX
status:
type: array
description: History of jobs states
items:
type: string
description: State of the job, MUST be one of EAE_JOB_STATUS_XXX
startDate:
type: string
format: dateTime
description: Timestamp tracking the creation of the job
main:
type: string
description: Main script file to execture
params:
type: array
description: Command line parameters for the script
items:
type: string
description: One parameter, can contain spaces
input:
type: array
description: List of file inputs for this job, including main script
items:
type: string
description: Name of one input file
endDate:
type: string
format: dateTime
description: Timestamp of when the job stops
exitCode:
type: integer
description: Exit code of the job processus
stdout:
type: string
description: Standard ouput TTY of the job processus
stderr:
type: string
description: Standard error TTY of the job processus
output:
type: array
description: List of files created in the local 'output' folder by the job process
items:
type: string
description: Name of the file
message:
type: string
description: Informative message on the last update operation