This repository was archived by the owner on Dec 1, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 20
Expand file tree
/
Copy pathswagger-backend.yaml
More file actions
276 lines (275 loc) · 7.57 KB
/
swagger-backend.yaml
File metadata and controls
276 lines (275 loc) · 7.57 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
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
271
272
273
274
275
276
---
swagger: '2.0'
info:
description: Flotta backend API for remote data storage
title: Flotta backend API
version: 1.0.0
contact:
name: Flotta flotta
url: 'https://github.com/project-flotta'
email: flotta@redhat.com
license:
name: Apache 2.0
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
tags:
- name: backend
description: Edge device backend storage management
schemes:
- https
consumes:
- application/json
produces:
- application/json
basePath: /api/flotta-backend/v1
definitions:
error:
type: object
required:
- message
properties:
message:
type: string
description: >-
Exposes the error message generated at the backend when there is an
error (example HTTP code 500).
device-configuration-response:
type: object
properties:
message:
type: string
description: >-
Exposes the error message generated at the backend when there is an
error (example HTTP code 500).
device-configuration:
x-go-type:
type: DeviceConfigurationMessage
import:
package: github.com/project-flotta/flotta-operator/models
alias: commonmodel
device-registration-status-response:
type: object
properties:
status:
type: string
description: >-
Returns the device registration status, which can be one of the
following {registered, unregistered, unknown}.
namespace:
type: string
description: >-
Namespace the device should be or was finally placed during registration.
message:
type: string
description: >-
Exposes the error message generated at the backend when there is an
error (example HTTP code 500).
paths:
'/namespaces/{namespace}/devices/{device-id}/configuration':
get:
description: Returns the device configuration
operationId: GetDeviceConfiguration
tags:
- backend
parameters:
- in: path
name: namespace
description: Namespace where the device resides
type: string
required: true
- in: path
name: device-id
description: Device ID
type: string
required: true
responses:
'200':
description: Success
schema:
$ref: '#/definitions/device-configuration-response'
'401':
description: Unauthorized
'403':
description: Forbidden
default:
description: Error
schema:
$ref: '#/definitions/device-configuration-response'
'/namespaces/{namespace}/devices/{device-id}/enrolment':
post:
description: Initiates the process of enrolling the device
operationId: EnrolDevice
tags:
- backend
parameters:
- in: path
name: namespace
description: Namespace where the device resides
type: string
required: true
- in: path
name: device-id
description: Device ID
type: string
required: true
- in: body
name: enrolment-info
required: true
schema:
x-go-type:
type: EnrolmentInfo
import:
package: github.com/project-flotta/flotta-operator/models
alias: commonmodel
responses:
'200':
description: OK
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
default:
description: Error
schema:
$ref: '#/definitions/error'
'/namespaces/{namespace}/devices/{device-id}/registration':
get:
description: >-
Returns a device registration status, which can be registered,
unregistered or unknown.
operationId: GetRegistrationStatus
tags:
- backend
parameters:
- in: path
name: namespace
description: Namespace where the device resides
type: string
required: true
- in: path
name: device-id
description: Device ID
type: string
required: true
responses:
'200':
description: OK
schema:
$ref: '#/definitions/device-registration-status-response'
'401':
description: Unauthorized
'403':
description: Forbidden
default:
description: Error
schema:
$ref: '#/definitions/device-registration-status-response'
put:
description: Registers the device by providing its hardware configuration
operationId: RegisterDevice
tags:
- backend
parameters:
- in: path
name: namespace
description: Namespace where the device resides
type: string
required: true
- in: path
name: device-id
description: Device ID
type: string
required: true
- in: body
name: registration-info
required: true
schema:
x-go-type:
type: RegistrationInfo
import:
package: github.com/project-flotta/flotta-operator/models
alias: commonmodel
responses:
'200':
description: Updated
'401':
description: Unauthorized
'403':
description: Forbidden
default:
description: Error
schema:
$ref: '#/definitions/error'
'/namespaces/{namespace}/devices/{device-id}/heartbeat':
put:
description: Updates the heartbeat information of the device.
operationId: UpdateHeartBeat
tags:
- backend
parameters:
- in: path
name: namespace
description: Namespace where the device resides
type: string
required: true
- in: path
name: device-id
description: Device ID
type: string
required: true
- in: body
name: heartbeat
required: true
schema:
type: object
x-go-type:
type: Heartbeat
import:
package: github.com/project-flotta/flotta-operator/models
alias: commonmodel
responses:
'200':
description: Success
'401':
description: Unauthorized
'403':
description: Forbidden
default:
description: Error
schema:
$ref: '#/definitions/error'
'/namespaces/{namespace}/devices/{device-id}/playbookexecutions':
get:
description: Returns the playbook executions.
operationId: GetPlaybookExecutions
tags:
- backend
parameters:
- in: path
name: namespace
description: Namespace where the device resides
type: string
required: true
- in: path
name: device-id
description: Device ID
type: string
required: true
responses:
'200':
description: OK
schema:
x-go-type:
type: PlaybookExecutionsResponse
import:
package: github.com/project-flotta/flotta-operator/models
alias: commonmodel
'401':
description: Unauthorized
'403':
description: Forbidden
default:
description: Error
schema:
$ref: '#/definitions/error'