-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.sandbox.system.yaml
More file actions
241 lines (241 loc) · 6.5 KB
/
openapi.sandbox.system.yaml
File metadata and controls
241 lines (241 loc) · 6.5 KB
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
openapi: 3.0.0
info:
title: Sandbox System API
description: API for managing sandbox system operations
version: 1.0.0
paths:
/system/update:
post:
summary: Update system
description: Update the sandbox system
operationId: systemUpdate
requestBody:
required: true
content:
application/json:
schema:
type: object
properties: {}
responses:
'200':
description: Successful operation
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/SuccessResponse'
- type: object
properties:
result:
type: object
properties: {}
'400':
description: Error updating system
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ErrorResponse'
- type: object
properties:
error:
$ref: '#/components/schemas/SystemError'
/system/hibernate:
post:
summary: Hibernate system
description: Put the sandbox system into hibernation mode
operationId: systemHibernate
requestBody:
required: true
content:
application/json:
schema:
type: object
properties: {}
responses:
'200':
description: Successful operation
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/SuccessResponse'
- type: object
properties:
result:
nullable: true
'400':
description: Error hibernating system
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ErrorResponse'
- type: object
properties:
error:
$ref: '#/components/schemas/SystemError'
/system/metrics:
post:
summary: Get system metrics
description: Retrieve current system metrics including CPU, memory and storage usage
operationId: systemMetrics
requestBody:
required: true
content:
application/json:
schema:
type: object
properties: {}
responses:
'200':
description: Successful operation
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/SuccessResponse'
- type: object
properties:
result:
$ref: '#/components/schemas/SystemMetricsStatus'
'400':
description: Error retrieving system metrics
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ErrorResponse'
- type: object
properties:
error:
$ref: '#/components/schemas/SystemError'
components:
schemas:
SuccessResponse:
type: object
properties:
status:
type: number
enum:
- 0
description: Status code for successful operations
result:
type: object
description: Result payload for the operation
required:
- status
- result
ErrorResponse:
type: object
properties:
status:
type: number
enum:
- 1
description: Status code for error operations
error:
type: object
description: Error details
required:
- status
- error
SystemError:
type: object
properties:
code:
type: number
description: Error code
message:
type: string
description: Error message
data:
type: object
description: Additional error data
nullable: true
required:
- code
- message
SystemMetricsStatus:
type: object
properties:
cpu:
type: object
properties:
cores:
type: number
description: Number of CPU cores
used:
type: number
description: Used CPU resources
configured:
type: number
description: Configured CPU resources
required:
- cores
- used
- configured
memory:
type: object
properties:
used:
type: number
description: Used memory in bytes
total:
type: number
description: Total available memory in bytes
configured:
type: number
description: Configured memory limit in bytes
required:
- used
- total
- configured
storage:
type: object
properties:
used:
type: number
description: Used storage in bytes
total:
type: number
description: Total available storage in bytes
configured:
type: number
description: Configured storage limit in bytes
required:
- used
- total
- configured
required:
- cpu
- memory
- storage
InitStatus:
type: object
properties:
message:
type: string
description: Status message
isError:
type: boolean
description: Whether the status represents an error
nullable: true
progress:
type: number
description: Current progress (0-100)
minimum: 0
maximum: 100
nextProgress:
type: number
description: Next progress target (0-100)
minimum: 0
maximum: 100
stdout:
type: string
description: Standard output from the initialization process
nullable: true
required:
- message
- progress
- nextProgress