blob: 284b372ed871c6e1a7d63bdb4da8bb1b71e4213a (
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
|
openapi: 3.0.3
info:
description: Support datajobs through one or more subjob for each DMI and Data Producer
Identifier combination
title: NCMP Data Subjob API
version: 1.0.0
servers:
- url: /dmi
tags:
- description: DMI plugin rest apis
name: dmi-datajob
paths:
/v1/readJob/{requestId}:
post:
description: Create a read request
operationId: readDataJob
parameters:
- description: Identifier for the overall Datajob
explode: false
in: path
name: requestId
required: true
schema:
example: some-identifier
type: string
style: simple
requestBody:
content:
application/3gpp-json-patch+json:
schema:
$ref: '#/components/schemas/SubjobReadRequest'
description: Operation body
responses:
"501":
content:
application/json:
example:
status: 501
message: Not Implemented
details: Method Not Implemented
schema:
$ref: '#/components/schemas/ErrorMessage'
description: Not Implemented
tags:
- dmi-datajob
/v1/writeJob/{requestId}:
post:
description: Create a write request
operationId: writeDataJob
parameters:
- description: Identifier for the overall Datajob
explode: false
in: path
name: requestId
required: true
schema:
example: some-identifier
type: string
style: simple
requestBody:
content:
application/3gpp-json-patch+json:
schema:
$ref: '#/components/schemas/SubjobWriteRequest'
description: Operation body
responses:
"501":
content:
application/json:
example:
status: 501
message: Not Implemented
details: Method Not Implemented
schema:
$ref: '#/components/schemas/ErrorMessage'
description: Not Implemented
tags:
- dmi-datajob
components:
parameters:
requestIdInPath:
description: Identifier for the overall Datajob
explode: false
in: path
name: requestId
required: true
schema:
example: some-identifier
type: string
style: simple
responses:
NotImplemented:
content:
application/json:
example:
status: 501
message: Not Implemented
details: Method Not Implemented
schema:
$ref: '#/components/schemas/ErrorMessage'
description: Not Implemented
schemas:
ErrorMessage:
properties:
status:
type: string
message:
type: string
details:
type: string
title: Error
type: object
SubjobReadRequest:
properties:
dataAcceptType:
description: Defines the data response accept type
example: application/vnd.3gpp.object-tree-hierarchical+json
type: string
dataContentType:
description: Defines the data request content type
example: application/3gpp-json-patch+json
type: string
dataProducerId:
description: ID of the producer registered by DMI for the paths in the operations
in this request
example: my-data-producer-identifier
type: string
data:
example:
op: read
operationId: 1
path: SubNetwork=Europe/SubNetwork=Ireland/MeContext=NR03gNodeBRadio00003/ManagedElement=NR03gNodeBRadio00003/GNBCUCPFunction=2
attributes: userLabel
scope:
scopeTyp: BASE_ONLY
items:
$ref: '#/components/schemas/SubjobReadRequest_data_inner'
type: array
required:
- data
- dataProducerId
type: object
SubjobWriteRequest:
properties:
dataAcceptType:
description: Defines the data response accept type
example: application/vnd.3gpp.object-tree-hierarchical+json
type: string
dataContentType:
description: Defines the data request content type
example: application/3gpp-json-patch+json
type: string
dataProducerId:
description: ID of the producer registered by DMI for the paths in the operations
in this request
example: my-data-producer-identifier
type: string
data:
example:
op: add
path: SubNetwork=Europe/SubNetwork=Ireland/MeContext=NR03gNodeBRadio00003/ManagedElement=NR03gNodeBRadio00003/GNBCUCPFunction=1/EUtraNetwork=1/EUtranFrequency=12
value:
id: 12
attributes:
userLabel: label12
items:
$ref: '#/components/schemas/SubjobWriteRequest_data_inner'
type: array
required:
- data
- dataProducerId
type: object
CmHandleProperties:
description: Private properties of the cm handle for the given path
type: object
Resource:
properties:
id:
description: Identifier of the resource object
example: resource-identifier
type: string
attributes:
additionalProperties:
example: "userLabel: label11"
type: string
description: Key value map representing the objects class attributes and
values
type: object
type: object
ActionParameters:
additionalProperties:
type: string
description: The input of the action in the form of key value pairs
type: object
Object:
type: object
SubjobReadRequest_data_inner:
properties:
path:
description: Defines the resource on which operation is executed
example: SubNetwork=Europe/SubNetwork=Ireland/MeContext=NR03gNodeBRadio00003/ManagedElement=NR03gNodeBRadio00003
type: string
op:
description: Describes the operation to execute
example: read
type: string
operationId:
description: Unique identifier for the operation within the request
example: "1"
type: string
attributes:
description: This parameter specifies the attributes of the scoped resources
that are returned
items:
example: cellId
type: string
type: array
fields:
description: This parameter specifies the attribute fields of the scoped
resources that are returned
items:
type: string
type: array
filter:
description: This parameter is used to filter the scoped Managed Objects.
Only Managed Objects passing the filter criteria will be fetched
example: NRCellDU/attributes/administrativeState==LOCKED
type: string
scopeType:
description: ScopeType selects MOs depending on relationships with Base
Managed Object
example: BASE_ONLY
type: string
scopeLevel:
description: Only used when the scope type is BASE_NTH_LEVEL to specify
amount of levels to search
example: 0
type: integer
moduleSetTag:
description: Module set identifier
example: my-module-set-tag
type: string
cmHandleProperties:
description: Private properties of the cm handle for the given path
type: object
required:
- op
- path
type: object
SubjobWriteRequest_data_inner_value:
description: Value dependent on the op specified. Resource for an add. Object
for a replace. ActionParameters for an action.
oneOf:
- $ref: '#/components/schemas/Resource'
- $ref: '#/components/schemas/ActionParameters'
- $ref: '#/components/schemas/Object'
type: object
SubjobWriteRequest_data_inner:
properties:
path:
description: Defines the resource on which operation is executed
example: SubNetwork=Europe/SubNetwork=Ireland/MeContext=NR03gNodeBRadio00003/ManagedElement=NR03gNodeBRadio00003
type: string
op:
description: Describes the operation to execute
example: add
type: string
operationId:
description: Unique identifier for the operation within the request
example: "1"
type: string
moduleSetTag:
description: Module set identifier
example: my-module-set-tag
type: string
cmHandleProperties:
description: Private properties of the cm handle for the given path
type: object
value:
$ref: '#/components/schemas/SubjobWriteRequest_data_inner_value'
required:
- op
- path
type: object
SubjobWriteResponse:
type: object
required:
- subJobId
- dmiServiceName
- dataProducerId
properties:
subJobId:
description: Unique identifier for the sub-job
example: my-sub-job-id
type: string
dmiServiceName:
description: Name of the relevant DMI Service
example: my-dmi-service
type: string
dataProducerId:
description: ID of the producer registered by DMI for the paths in the operations in this request
example: my-data-producer-identifier
type: string
|
