This repository has been archived by the owner on Apr 17, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathswagger.yaml
302 lines (302 loc) · 7.75 KB
/
swagger.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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
basePath: /api
consumes:
- application/json
definitions:
App:
description: App is the model struct for apps
properties:
appId:
type: string
x-go-name: AppID
appName:
type: string
x-go-name: AppName
deletedAt:
type: string
x-go-name: DeletedAt
deployedVersions:
items:
$ref: '#/definitions/Version'
type: array
x-go-name: DeployedVersions
id:
type: string
x-go-name: ID
numOfAppLaunches:
format: int64
type: integer
x-go-name: NumOfAppLaunches
numOfCurrentInstalls:
format: int64
type: integer
x-go-name: NumOfCurrentInstalls
numOfDeployedVersions:
format: int64
type: integer
x-go-name: NumOfDeployedVersions
type: object
x-go-package: github.com/aerogear/mobile-security-service/pkg/models
Device:
description: Device model
properties:
appId:
type: string
x-go-name: AppID
deviceId:
type: string
x-go-name: DeviceID
deviceType:
type: string
x-go-name: DeviceType
deviceVersion:
type: string
x-go-name: DeviceVersion
id:
type: string
x-go-name: ID
version:
type: string
x-go-name: Version
versionId:
type: string
x-go-name: VersionID
type: object
x-go-package: github.com/aerogear/mobile-security-service/pkg/models
User:
description: User is the model struct for users
properties:
email:
type: string
x-go-name: Email
username:
type: string
x-go-name: Username
type: object
x-go-package: github.com/aerogear/mobile-security-service/pkg/models
Version:
description: Version model
properties:
appId:
type: string
x-go-name: AppID
devices:
items:
$ref: '#/definitions/Device'
type: array
x-go-name: Devices
disabled:
type: boolean
x-go-name: Disabled
disabledMessage:
type: string
x-go-name: DisabledMessage
id:
type: string
x-go-name: ID
lastLaunchedAt:
type: string
x-go-name: LastLaunchedAt
numOfAppLaunches:
format: int64
type: integer
x-go-name: NumOfAppLaunches
numOfCurrentInstalls:
format: int64
type: integer
x-go-name: NumOfCurrentInstalls
version:
type: string
x-go-name: Version
type: object
x-go-package: github.com/aerogear/mobile-security-service/pkg/models
info:
description: This is a sample mobile security service server.
title: API for Mobile Security Service
version: 0.2.1
paths:
/apps:
get:
description: Returns root level information for all apps
operationId: getApps
parameters:
- description: The app_id to filter the app by appId
in: query
name: appId
type: string
produces:
- application/json
responses:
"200":
description: successful operation
schema:
$ref: '#/definitions/App'
"204":
description: successful operation by no apps were found
"404":
description: App not found
summary: Retrieve list of apps
/apps/:id/versions:
put:
description: Update all versions informed of an app using the app id, including
updating version information
operationId: UpdateAppVersions
parameters:
- description: The id for the app that will have its versions updated
in: path
name: id
required: true
type: string
- description: Updated 1 or more versions of an app
in: body
name: body
required: true
schema:
$ref: '#/definitions/Version'
produces:
- application/json
responses:
"200":
description: successful update
"400":
description: Invalid app and/or versions supplied
"404":
description: App not found
summary: Update 1 or more versions of an app
/apps/:id/versions/disable:
post:
description: Disable all versions of an app
operationId: updateApp
parameters:
- description: The id for the app that will have all its versions updated
in: path
name: id
required: true
type: string
- in: body
name: body
required: true
schema:
$ref: '#/definitions/Version'
produces:
- application/json
responses:
"200":
description: successful update
"400":
description: Invalid app supplied
"404":
description: App not found
summary: Disable all versions of an app
/apps/{id}:
delete:
description: To do a a soft deleted at the App
operationId: DeleteAppById
parameters:
- description: The id for the app that needs to be fetched.
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"204":
description: successful operation
"400":
description: Invalid id supplied
"404":
description: App not found
summary: Does a soft delete at in the App
get:
description: Retrieve all information for a single app including all child information
operationId: GetActiveAppByID
parameters:
- description: The id for the app that needs to be fetched.
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: successful operation
schema:
$ref: '#/definitions/App'
"400":
description: Invalid id supplied
"404":
description: App not found
summary: Get app by id
/healthz:
get:
description: Check the health of the REST SERVICE API
operationId: health
produces:
- application/json
responses:
"200":
description: successful operation
"500":
description: Internal Server Error
summary: Check if the server can receive requests
/init:
post:
description: Capture metrics from device and return if the app version they
are using is disabled and has a set disabled message
operationId: initAppFromDevice
parameters:
- description: Updated app object
in: body
name: body
required: true
schema:
$ref: '#/definitions/Version'
produces:
- application/json
responses:
"200":
description: successful operation
"400":
description: Invalid id supplied
"404":
description: Data not found
summary: Init call from SDK
/metrics:
get:
description: Get the metrics of the service
operationId: metrics
produces:
- application/json
responses:
"200":
description: successful operation
summary: Retrieve all metrics for the Go server
/ping:
get:
description: Check the status of the REST SERVICE API
operationId: status
produces:
- application/json
responses:
"200":
description: successful operation
summary: Check if the server is running
/user:
get:
description: Returns user
operationId: getUser
produces:
- application/json
responses:
"200":
description: sucessful operation
"404":
description: No user found
summary: Retrieve user
produces:
- application/json
schemes:
- http
- https
swagger: "2.0"