-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi_schema.yaml
270 lines (269 loc) · 6.78 KB
/
api_schema.yaml
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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
openapi: '3.0.0'
info:
title: firecream
description: These APIs provide step configs for icecream
version: 0.2.2
servers:
- url: /api
paths:
/echo:
get:
summary: Health test
responses:
'200':
description: OK
/steps:
get:
summary: Get all steps
parameters:
- name: name
in: query
required: false
schema:
type: string
- name: author
in: query
required: false
schema:
type: string
responses:
'200':
description: Return all matched steps.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/StepRes'
'500':
description: Internal error.
post:
summary: Create a new step.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StepReq'
responses:
'201':
description: Step created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/StepRes'
'400':
$ref: '#/components/responses/BadRequest'
'409':
description: Step name already exists.
'500':
description: Internal error.
/steps/{id}:
get:
summary: Return specific project detail infomation
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
description: Return matched project information.
content:
application/json:
schema:
$ref: '#/components/schemas/StepRes'
'404':
description: Step not found.
'500':
description: Internal error.
put:
summary: Update properties for a selected step.
parameters:
- in: path
name: id
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StepReq'
responses:
'200':
description: Updated project properties successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/StepRes'
'400':
$ref: '#/components/responses/BadRequest'
'404':
description: Step not found.
'500':
description: Internal error.
delete:
summary: Delete step by step_id
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
description: Step is deleted successfully.
'404':
description: Step not found.
'500':
description: Internal error.
components:
responses:
BadRequest:
description: Bad request.
content:
text/plain:
schema:
type: string
schemas:
StepReq:
type: object
properties:
name:
type: string
author:
type: string
step_type:
type: string
config:
type: object
anyOf:
- $ref: '#/components/schemas/Install_conda'
- $ref: '#/components/schemas/Conda_install'
- $ref: '#/components/schemas/Custom_command'
- $ref: '#/components/schemas/Git_clone'
- $ref: '#/components/schemas/Hdfs_download'
- $ref: '#/components/schemas/Install_python'
- $ref: '#/components/schemas/Install_git'
- $ref: '#/components/schemas/Pip_install'
StepRes:
type: object
properties:
id:
type: string
name:
type: string
author:
type: string
step_type:
type: string
config:
type: object
anyOf:
- $ref: '#/components/schemas/Install_conda'
- $ref: '#/components/schemas/Conda_install'
- $ref: '#/components/schemas/Custom_command'
- $ref: '#/components/schemas/Git_clone'
- $ref: '#/components/schemas/Hdfs_download'
- $ref: '#/components/schemas/Install_python'
- $ref: '#/components/schemas/Install_git'
- $ref: '#/components/schemas/Pip_install'
createAt:
type: string
format: datetime
updateAt:
type: string
format: datetime
Install_conda:
type: object
properties:
python_version:
type: string
default: '3.6'
conda_version:
type: string
default: latest
env_name:
type: string
bit:
type: string
enum:
- '32'
- '64'
Conda_install:
type: object
properties:
packages:
type: array
items:
type: string
description: the package follows conda package match specifications.
Custom_command:
type: object
properties:
command:
type: string
Git_clone:
type: object
properties:
url:
type: string
branch:
type: string
tag:
type: string
Hdfs_download:
type: object
oneOf:
- description: token client
properties:
url:
type: string
description: the web hdfs url
client_type:
type: string
enum:
- TokenClient
source_path:
type: string
destination_path:
type: string
token:
type: string
- description: insecure client
properties:
url:
type: string
description: the web hdfs url
client_type:
type: string
enum:
- InsecureClient
source_path:
type: string
description: the path from hdfs server to be downloaded
destination_path:
type: string
description: the path where hdfs data downloaded into
user:
type: string
Install_python:
type: object
properties:
version:
type: string
Install_git:
type: object
properties:
config:
type: object
Pip_install:
type: object
properties:
packages:
type: array
items:
type: string