blob: 9b3de2a84f993d083d8b5a12ed48a38b074cb45c (
plain)
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
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
|
swagger: '2.0'
info:
description: API reference for Distributed Key Value store.
version: 1.0.0
title: API reference for Distributed Key Value store
contact:
email: shashank.kumar.shankar@intel.com
url: 'https://wiki.onap.org/pages/viewpage.action?pageId=16010913'
license:
name: Apache 2.0
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
basePath: /v1
schemes:
- http
paths:
/register:
post:
tags:
- Domain
summary: Endpoint to Register new domain
description: ''
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: Register new domain.
required: true
schema:
$ref: '#/definitions/RegisterDomainPOSTRequest'
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/RegisterDomainPOSTResponse'
'/register/{token}':
get:
tags:
- Domain
summary: Check if domain is registered.
description: Check if domain is registered identified by token.
produces:
- application/json
parameters:
- name: token
in: path
description: Token used to query
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/RegisterDomainGETResponse'
delete:
tags:
- Domain
summary: Delete registered domain.
description: Deletes a registered domain identified by token.
produces:
- application/json
parameters:
- name: token
in: path
description: Token used to delete
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/RegisterDomainDELETEResponse'
'/register/{token}/subdomain':
post:
tags:
- Subdomain
summary: Endpoint to Register new subdomain
description: ''
consumes:
- application/json
produces:
- application/json
parameters:
- name: token
in: path
description: Token used to identify domain.
required: true
type: string
- in: body
name: body
description: Register new subdomain.
required: true
schema:
$ref: '#/definitions/RegisterSubdomainPOSTRequest'
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/RegisterSubdomainPOSTResponse'
'/register/{token}/subdomain/{subdomain}':
delete:
tags:
- Subdomain
summary: Delete registered subdomain.
description: Deletes a registered subdomain identified by token and subdomain.
produces:
- application/json
parameters:
- name: token
in: path
description: Token used to delete
required: true
type: string
- name: subdomain
in: path
description: Subdomain used to delete
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/RegisterSubDomainDELETEResponse'
/config:
post:
tags:
- Config
summary: Endpoint to upload configuration.
description: Endpoint to upload configuration.
consumes:
- multipart/form-data
produces:
- application/json
parameters:
- name: configFile
in: formData
description: Config file to be uploaded.
required: true
type: file
- name: token
in: formData
description: Token to identify domain to upload config file to.
required: true
type: string
- name: subdomain
in: formData
description: Subdomain to identify subdomain to upload config file to.
required: false
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/ConfigUploadResponse'
'/config/{token}/{filename}':
get:
tags:
- Config
summary: Get config file.
description: Get config file identified by token and filename.
produces:
- file
parameters:
- name: token
in: path
description: Token used to get config file.
required: true
type: string
- name: filename
in: path
description: Filename used to get config file.
required: true
type: string
responses:
'200':
description: successful operation
delete:
tags:
- Config
summary: Delete config file.
description: Deletes a config file identified by token and filename.
produces:
- application/json
parameters:
- name: token
in: path
description: Token used to delete
required: true
type: string
- name: filename
in: path
description: Filename used to delete
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/ConfigDomainDELETEResponse'
'/config/{token}/{subdomain}/{filename}':
get:
tags:
- Config
summary: Get config file from subdomain.
description: 'Get config file identified by token, filename and subdomain.'
produces:
- file
parameters:
- name: token
in: path
description: Token used to get config file.
required: true
type: string
- name: subdomain
in: path
description: Subdomain used to get config file.
required: true
type: string
- name: filename
in: path
description: Filename used to get config file.
required: true
type: string
responses:
'200':
description: successful operation
delete:
tags:
- Config
summary: Delete config file from subdomain.
description: 'Deletes a config file identified by token, filename and subdomain.'
produces:
- application/json
parameters:
- name: token
in: path
description: Token used to delete config file.
required: true
type: string
- name: subdomain
in: path
description: Subdomain used to delete config file.
required: true
type: string
- name: filename
in: path
description: Filename used to delete config file.
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/ConfigSubDomainDELETEResponse'
/config/load:
post:
tags:
- Config
summary: Load config into Consul.
description: Load config into Consul upon hitting the endpoint.
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: Load configuration from file system to be added into Consul
required: true
schema:
$ref: '#/definitions/ConfigLoadPOSTRequest'
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/ConfigLoadPOSTResponse'
/config/load-default:
get:
tags:
- Config
summary: Load default config into Consul.
description: Load default config into Consul upon hitting the endpoint.
produces:
- application/json
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/ConfigDefaultGETResponse'
/getconfigs:
get:
tags:
- Consul operation
summary: Get all keys present in Consul.
description: Returns a list of keys present in Consul.
produces:
- application/json
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/ConsulGETAllResponse'
'/getconfig/{key}':
get:
tags:
- Consul operation
summary: Get value for specific key present in Consul.
description: Returns a key and value present in Consul.
produces:
- application/json
parameters:
- name: key
in: path
description: Key used to query Consul.
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/ConsulGETResponse'
'/deleteconfig/{key}':
delete:
tags:
- Consul operation
summary: Delete value for specific key present in Consul.
description: Deletes a specific key.
produces:
- application/json
parameters:
- name: key
in: path
description: Key used to delete
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/ConsulDELETEResponse'
definitions:
RegisterDomainPOSTRequest:
type: object
properties:
domain:
type: string
RegisterDomainPOSTResponse:
type: object
properties:
response:
type: string
RegisterDomainGETResponse:
type: object
properties:
response:
type: string
RegisterDomainDELETEResponse:
type: object
properties:
response:
type: string
RegisterSubdomainPOSTRequest:
type: object
properties:
subdomain:
type: string
RegisterSubdomainPOSTResponse:
type: object
properties:
response:
type: string
RegisterSubDomainDELETEResponse:
type: object
properties:
response:
type: string
ConfigUploadResponse:
type: object
properties:
response:
type: string
ConfigDomainDELETEResponse:
type: object
properties:
response:
type: string
ConfigSubDomainDELETEResponse:
type: object
properties:
response:
type: string
ConfigLoadPOSTRequest:
type: object
properties:
token:
type: string
filename:
type: string
subdomain:
type: string
ConfigLoadPOSTResponse:
type: object
properties:
response:
type: string
ConfigDefaultGETResponse:
type: object
properties:
response:
type: string
ConsulGETAllResponse:
type: object
properties:
response:
items:
type: string
ConsulGETResponse:
type: object
properties:
response:
type: string
ConsulDELETEResponse:
type: object
properties:
response:
type: string
|
