forked from ObjectIsAdvantag/DEVWKS-2043
-
Notifications
You must be signed in to change notification settings - Fork 0
/
step9.yaml
403 lines (400 loc) · 12.8 KB
/
step9.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
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
openapi: 3.0.0
info:
version: 1.24.0-5136
title: IncrementalSteps MiniDashboard API
description: >
The MiniDashboard API is a modern REST API based on the OpenAPI
specification. [Recent Updates](https://developer.cisco.com/).
contact:
name: Developer Community
url: https://developer.cisco.com
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://incrementalsteps.io/api/v1
security:
- mini_api_key: []
components:
securitySchemes:
mini_api_key:
type: apiKey
name: X-Incremental-Dashboard-API-Key
in: header
paths:
/organizations:
get:
description: List the organizations that the user has privileges on
operationId: getOrganizations
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
description: Organization ID
name:
type: string
description: Organization name
url:
type: string
description: Organization URL
api:
type: object
properties:
enabled:
type: boolean
description: Enable API access
description: API related settings
licensing:
type: object
properties:
model:
type: string
enum:
- co-term
- per-device
- subscription
description: Organization licensing model. Can be 'co-term', 'per-device', or 'subscription'.
description: Licensing related settings
cloud:
type: object
properties:
region:
type: object
properties:
name:
type: string
description: Name of region
description: Region info
description: Data for this organization
'401':
description: unauthorized
'429':
description: too many requests
'500':
description: internal service error
'502':
description: bad gateway
'503':
description: service unavailable
'504':
description: gateway timeout
summary: List the organizations that the user has privileges on
tags:
- read
post:
description: Create a new organization
operationId: createOrganization
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: The name of the organization
licensing:
type: object
properties:
model:
type: string
enum:
- co-term
- per-device
- subscription
description: Organization licensing model. Can be 'co-term', 'per-device', or 'subscription'.
description: Licensing related settings
required:
- name
- licensing
required: true
responses:
'201':
description: Successful operation
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Organization ID
name:
type: string
description: Organization name
url:
type: string
description: Organization URL
api:
type: object
properties:
enabled:
type: boolean
description: Enable API access
description: API related settings
licensing:
type: object
properties:
model:
type: string
enum:
- co-term
- per-device
- subscription
description: Organization licensing model. Can be 'co-term', 'per-device', or 'subscription'.
description: Licensing related settings
cloud:
type: object
properties:
region:
type: object
properties:
name:
type: string
description: Name of region
description: Region info
description: Data for this organization
'400':
description: bad request
'401':
description: unauthorized
'403':
description: forbidden
'429':
description: too many requests
'500':
description: internal service error
'502':
description: bad gateway
'503':
description: service unavailable
'504':
description: gateway timeout
summary: Create a new organization
tags:
- configure
/organizations/{organizationId}:
get:
description: Return an organization
operationId: getOrganization
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Organization ID
name:
type: string
description: Organization name
url:
type: string
description: Organization URL
api:
type: object
properties:
enabled:
type: boolean
description: Enable API access
description: API related settings
licensing:
type: object
properties:
model:
type: string
enum:
- co-term
- per-device
- subscription
description: Organization licensing model. Can be 'co-term', 'per-device', or 'subscription'.
description: Licensing related settings
cloud:
type: object
properties:
region:
type: object
properties:
name:
type: string
description: Name of region
description: Region info
description: Data for this organization
'401':
description: unauthorized
'403':
description: forbidden
'429':
description: too many requests
'500':
description: internal service error
'502':
description: bad gateway
'503':
description: service unavailable
'504':
description: gateway timeout
summary: Return an organization
tags:
- read
delete:
description: Delete an organization
operationId: deleteOrganization
parameters:
- name: organizationId
in: path
schema:
type: string
required: true
responses:
'204':
description: Successful operation
'401':
description: unauthorized
'403':
description: forbidden
'429':
description: too many requests
'500':
description: internal service error
'502':
description: bad gateway
'503':
description: service unavailable
'504':
description: gateway timeout
summary: Delete an organization
tags:
- configure
put:
operationId: updateOrganization
description: Update the organization with the provided identifier
summary: Update Organization
parameters:
- name: organizationId
in: path
schema:
type: string
example: Amsterdam
required: true
description: Organization Identifier
requestBody:
description: organization to update
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: The name of the organization
api:
type: object
properties:
enabled:
type: boolean
description: If true, enable the access to the Mini Dashboard API
description: API-specific settings
examples:
Amsterdam:
value:
name: Amsterdam Office
api:
enabled: true
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Organization Identifier
name:
type: string
description: Organization Name
url:
type: string
description: Organization Url
api:
type: object
properties:
enabled:
type: boolean
description: Enable API access
description: API settings
licensing:
type: object
properties:
model:
type: string
enum:
- co-term
- per-device
- subscription
description: Organization licensing model. Can be 'co-term', 'per-device', or 'subscription'.
description: Licensing settings
cloud:
type: object
properties:
region:
type: object
properties:
name:
type: string
description: Name of region
description: Region details
description: Cloud nfrastructure details
examples:
SanFrancisco:
value:
id: SanFrancisco
name: San Francisco HeadQuarters
url: https://dashboard.mini.com/o/SanFrancisco/manage/organization/overview
api:
enabled: true
licensing:
model: co-term
cloud:
region:
name: North America
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'429':
description: Too many requests
'500':
description: Internal service error
'502':
description: Bad gateway
'503':
description: Service unavailable
'504':
description: Gateway timeout
tags:
- configure
tags:
- name: read
- name: configure