blob: 61cd091da30640c915a9f564e75fcaf3cf7541e2 (
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
|
swagger: '2.0'
info:
description: This is a service that provides secret management facilities
version: 1.0.0
title: Secret Management Service
contact:
email: kiran.k.kamineni@intel.com
license:
name: Apache 2.0
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
host: 'aaf.onap.org:10443'
basePath: /v1/sms/
tags:
- name: system
description: Operations related to quorum client which are not useful to clients
- name: login
description: Operations related to username password based authentication
- name: domain
description: Operations related to Secret Domains
- name: secret
description: Operations related to Secrets
schemes:
- https
paths:
/login:
post:
tags:
- login
summary: Login with username and password
description: Operations related to logging in via username and Password
consumes:
- application/json
produces:
- application/json
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/Credential'
responses:
'200':
description: Successful Login returns a token
schema:
type: object
properties:
token:
type: string
ttl:
type: integer
description: ttl of returned token in seconds
'404':
description: Invalid Username or Password
/status:
get:
tags:
- system
description: Gets current backend status. This API is used only by quorum clients
summary: Get backend status
produces:
- application/json
responses:
'200':
description: Successful operation
schema:
type: object
properties:
sealstatus:
type: string
description: seal status of backend
'404':
description: Invalid Path or Path not found
/unseal:
post:
tags:
- system
description: Sends unseal shard to unseal if backend is sealed
summary: Unseal backend
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
required: true
schema:
type: object
properties:
unsealshard:
type: string
description: >-
Unseal shard that will be used along with other shards to
unseal backend
responses:
'201':
description: Submitted unseal key
'404':
description: Invalid Path or Path not found
/domain:
post:
tags:
- domain
summary: Add a new domain
description: ''
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
required: true
schema:
$ref: '#/definitions/Domain'
responses:
'201':
description: Successful Creation
schema:
$ref: '#/definitions/Domain'
'400':
description: Invalid input
'500':
description: Internal Server Error
'/domain/{domainName}':
delete:
tags:
- domain
description: Deletes a domain with provided name
summary: Deletes a domain by name
produces:
- application/json
parameters:
- name: domainName
in: path
description: Name of the domain
required: true
type: string
responses:
'204':
description: Successful Deletion
'404':
description: Invalid Path or Path not found
'/domain/{domainName}/secret':
post:
tags:
- secret
summary: Add a new secret
description: ''
consumes:
- application/json
produces:
- application/json
parameters:
- name: domainName
in: path
description: Name of the domain
required: true
type: string
- name: body
in: body
required: true
schema:
$ref: '#/definitions/Secret'
responses:
'201':
description: Successful Creation
'404':
description: Invalid Path or Path not found
get:
tags:
- secret
description: Gets all secret names in this domain
summary: List secret Names in this domain
produces:
- application/json
parameters:
- name: domainName
in: path
description: Name of the domain in which to look at
required: true
type: string
responses:
'200':
description: Successful operation
schema:
type: object
properties:
secretnames:
type: array
items:
type: string
description: Array of strings referencing the secret names
example:
secretnames: ["secretname1", "secretname2", "secretname3"]
'404':
description: Invalid Path or Path not found
'/domain/{domainName}/secret/{secretName}':
get:
tags:
- secret
summary: Find Secret by Name
description: Returns a single secret
produces:
- application/json
parameters:
- name: domainName
in: path
description: Name of the domain in which to look at
required: true
type: string
- name: secretName
in: path
description: Name of the secret which is needed
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/Secret'
'404':
description: Invalid Path or Path not found
delete:
tags:
- secret
summary: Deletes a Secret
description: ''
produces:
- application/json
parameters:
- name: secretName
in: path
description: Name of Secret to Delete
required: true
type: string
- name: domainName
in: path
required: true
description: Path to the SecretDomain which contains the Secret
type: string
responses:
'204':
description: Successful Deletion
'404':
description: Invalid Path or Path not found
securityDefinitions:
token:
type: apiKey
name: token
in: header
definitions:
Credential:
type: object
properties:
username:
type: string
password:
type: string
Domain:
type: object
properties:
uuid:
type: string
description: >-
Optional value provided by user. If user does not provide, server will
auto generate
name:
type: string
description: Name of the secret domain under which all secrets will be stored
Secret:
type: object
properties:
name:
type: string
description: Name of the secret
values:
description: Map of key value pairs that constitute the secret
type: object
additionalProperties:
type: object
example:
name: john
Age: 40
admin: true
externalDocs:
description: Find out more about Swagger
url: 'http://swagger.io'
|
