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
|
# ============LICENSE_START=======================================================
# Copyright (C) 2021 Nordix Foundation
# Modifications Copyright (C) 2021 Pantheon.tech
# ================================================================================
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0
# ============LICENSE_END=========================================================
components:
schemas:
# Common Schemas
ErrorMessage:
type: object
title: Error
properties:
status:
type: string
message:
type: string
details:
type: string
# Request Schemas
RestDmiPluginRegistration:
type: object
properties:
dmiPlugin:
type: string
example: onap-dmi-plugin
createdCmHandles:
type: array
items:
$ref: '#/components/schemas/RestCmHandle'
updatedCmHandles:
type: array
items:
$ref: '#/components/schemas/RestCmHandle'
removedCmHandles:
type: array
items:
type: string
RestCmHandle:
required:
- cmHandle
type: object
properties:
cmHandle:
type: string
example: cmHandle123
cmHandleProperties:
$ref: '#/components/schemas/RestCmHandleAdditionalProperties'
RestCmHandleAdditionalProperties:
type: object
additionalProperties:
type: string
example: system-001
Conditions:
type: object
properties:
conditions:
$ref: '#/components/schemas/ConditionsData'
ConditionsData:
type: array
items:
type: object
$ref: '#/components/schemas/ConditionProperties'
ConditionProperties:
properties:
name:
type: string
example: hasAllModules
conditionParameters:
$ref: '#/components/schemas/ModuleNamesAsJsonArray'
ModuleNamesAsJsonArray:
type: array
items:
type: object
$ref: '#/components/schemas/ModuleNameAsJsonObject'
ModuleNameAsJsonObject:
properties:
moduleName:
type: string
example: someModuleName
#Response Schemas
CmHandles:
type: object
properties:
cmHandles:
$ref: '#/components/schemas/CmHandleProperties'
CmHandleProperties:
type: array
items:
type: object
$ref: '#/components/schemas/CmHandleProperty'
CmHandleProperty:
properties:
cmHandleId:
type: string
example: someCmHandleId
parameters:
cmHandleInPath:
name: cm-handle
in: path
description: The identifier for a network function, network element, subnetwork or any other cm object by managed Network CM Proxy
required: true
schema:
type: string
xpathInQuery:
name: xpath
in: query
description: xpath
required: false
schema:
type: string
default: /
requiredXpathInQuery:
name: xpath
in: query
description: xpath
required: true
schema:
type: string
includeDescendantsOptionInQuery:
name: include-descendants
in: query
description: include-descendants
required: false
schema:
type: boolean
default: false
cpsPathInQuery:
name: cps-path
in: query
description: cps-path
required: false
schema:
type: string
default: /
resourceIdentifierInQuery:
name: resourceIdentifier
in: query
description: The format of resource identifier depend on the associated DMI Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but it can really be anything.
required: true
allowReserved: true
schema:
type: string
examples:
sample1:
value:
resourceIdentifier: \parent\child
sample2:
value:
resourceIdentifier: \parent\listElement[key=value]
sample3:
value:
resourceIdentifier: \parent\listElement[key=value]\grandChild
sample4:
value:
resourceIdentifier: parent=1,child=abc
acceptParamInHeader:
name: Accept
in: header
required: false
description: Accept parameter for response, if accept parameter is null, that means client can accept any format.
schema:
type: string
enum: [ application/json, application/yang-data+json ]
optionsParamInQuery:
name: options
in: query
description: options parameter in query, it is mandatory to wrap key(s)=value(s) in parenthesis'()'.
required: false
schema:
type: string
allowReserved: true
examples:
sample1:
value:
options: (key1=value1,key2=value2)
sample2:
value:
options: (key1=value1,key2=value1/value2)
sample3:
value:
options: (key1=10,key2=value2,key3=[val31;val32])
contentParamInHeader:
name: Content-Type
in: header
required: false
description: Content parameter for request, if content parameter is null, default value is application/json.
schema:
type: string
default: application/json
responses:
NotFound:
description: The specified resource was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
Unauthorized:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
Forbidden:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
BadRequest:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
Conflict:
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
NotImplemented:
description: The given path has not been implemented
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
Ok:
description: OK
content:
application/json:
schema:
type: object
Created:
description: Created
content: {}
NoContent:
description: No Content
content: {}
|
