-
Notifications
You must be signed in to change notification settings - Fork 2
/
step3.yaml
230 lines (225 loc) · 7.14 KB
/
step3.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
openapi: 3.0.0
info:
version: v1.22
title: 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://api.mini.com/api/v1
security:
- mini_api_key: []
components:
securitySchemes:
mini_api_key:
type: apiKey
name: X-Mini-Dashboard-API-Key
in: header
description: Secret to access the API
paths:
/organizations:
get:
description: List the organizations that the user has privileges on whitelist
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
examples:
response:
value:
- id: '2930418'
name: My organization
url: >-
https://dashboard.mini.com/o/VjjsAd/manage/organization/overview
api:
enabled: true
licensing:
model: co-term
cloud:
region:
name: North America
summary: List organizations
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
required:
- name
required: true
responses:
'201':
description: Successful operation
content:
application/json:
schema:
type: object
examples:
successResponse:
value:
id: '2930418'
name: My organization
url: >-
https://dashboard.mini.com/o/VjjsAd/manage/organization/overview
api:
enabled: true
licensing:
model: co-term
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
examples:
response:
value:
id: '2930418'
name: My organization
url: >-
https://dashboard.mini.com/o/VjjsAd/manage/organization/overview
api:
enabled: true
licensing:
model: co-term
cloud:
region:
name: North America
summary: Return an organization
tags:
- read
delete:
description: Delete an organization
operationId: deleteOrganization
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
responses:
'204':
description: Successful operation
summary: Delete an organization
tags:
- configure
tags:
- name: read
- name: configure