Merge "OAuth2 support"
[pti/o2.git] / docs / swagger.yaml
1 ---
2 swagger: "2.0"
3 info:
4   description: Swagger OpenAPI document for the INF O2 Services
5   version: 1.0.0
6   title: INF O2 Services API
7 basePath: /
8 tags:
9 - name: O2IMS-InfrastructureInventory
10   description: O2 IMS Inventory related operations.
11 - name: O2IMS-InfrastructureMonitoring
12   description: O2 IMS Monitoring related operations.
13 consumes:
14 - application/json
15 produces:
16 - application/json
17 paths:
18   /o2ims-infrastructureInventory/api_versions:
19     get:
20       tags:
21       - O2IMS-InfrastructureInventory
22       operationId: Get Inventory Version
23       parameters: []
24       responses:
25         "200":
26           description: Success
27           schema:
28             $ref: '#/definitions/InventoryAPIVersion'
29   /o2ims-infrastructureInventory/v1:
30     get:
31       tags:
32       - O2IMS-InfrastructureInventory
33       operationId: Get Ocloud Information
34       parameters:
35       - name: exclude_default
36         in: query
37         description: "Exclude showing all default fields, Set \"true\" to enable."
38         required: false
39         type: string
40       - name: exclude_fields
41         in: query
42         description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
43         required: false
44         type: string
45       - name: fields
46         in: query
47         description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
48         required: false
49         type: string
50       - name: all_fields
51         in: query
52         description: Set any value for show all fields. This value will cover "fields" and "all_fields".
53         required: false
54         type: string
55       responses:
56         "200":
57           description: Success
58           schema:
59             $ref: '#/definitions/OcloudDto'
60         "404":
61           description: oCloud not found
62   /o2ims-infrastructureInventory/v1/:
63     get:
64       tags:
65       - O2IMS-InfrastructureInventory
66       operationId: Get Ocloud Information
67       parameters:
68       - name: exclude_default
69         in: query
70         description: "Exclude showing all default fields, Set \"true\" to enable."
71         required: false
72         type: string
73       - name: exclude_fields
74         in: query
75         description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
76         required: false
77         type: string
78       - name: fields
79         in: query
80         description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
81         required: false
82         type: string
83       - name: all_fields
84         in: query
85         description: Set any value for show all fields. This value will cover "fields" and "all_fields".
86         required: false
87         type: string
88       responses:
89         "200":
90           description: Success
91           schema:
92             $ref: '#/definitions/OcloudDto'
93         "404":
94           description: oCloud not found
95   /o2ims-infrastructureInventory/v1/api_versions:
96     get:
97       tags:
98       - O2IMS-InfrastructureInventory
99       operationId: Get Inventory API version
100       parameters: []
101       responses:
102         "200":
103           description: Success
104           schema:
105             $ref: '#/definitions/InventoryV1APIVersion'
106   /o2ims-infrastructureInventory/v1/deploymentManagers:
107     get:
108       tags:
109       - O2IMS-InfrastructureInventory
110       operationId: Get Deployment Manager List
111       parameters:
112       - name: filter
113         in: query
114         description: Filter of the query.
115         required: false
116         type: string
117       - name: exclude_default
118         in: query
119         description: "Exclude showing all default fields, Set \"true\" to enable."
120         required: false
121         type: string
122       - name: exclude_fields
123         in: query
124         description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
125         required: false
126         type: string
127       - name: fields
128         in: query
129         description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
130         required: false
131         type: string
132       - name: all_fields
133         in: query
134         description: Set any value for show all fields. This value will cover "fields" and "all_fields".
135         required: false
136         type: string
137       - name: nextpage_opaque_marker
138         in: query
139         description: "Page number of the results to fetch. Default: 1"
140         required: false
141         type: string
142         default: "1"
143       responses:
144         "200":
145           description: Success
146           schema:
147             type: array
148             items:
149               $ref: '#/definitions/DeploymentManagerListDto'
150   /o2ims-infrastructureInventory/v1/deploymentManagers/{deploymentManagerID}:
151     get:
152       tags:
153       - O2IMS-InfrastructureInventory
154       operationId: Get Deployment Manager Information
155       parameters:
156       - name: exclude_default
157         in: query
158         description: "Exclude showing all default fields, Set \"true\" to enable."
159         required: false
160         type: string
161       - name: exclude_fields
162         in: query
163         description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
164         required: false
165         type: string
166       - name: fields
167         in: query
168         description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
169         required: false
170         type: string
171       - name: all_fields
172         in: query
173         description: Set any value for show all fields. This value will cover "fields" and "all_fields".
174         required: false
175         type: string
176       - name: profile
177         in: query
178         description: "DMS profile: value supports \"native_k8sapi\""
179         required: false
180         type: string
181       - name: deploymentManagerID
182         in: path
183         description: ID of the deployment manager
184         required: true
185         type: string
186       responses:
187         "200":
188           description: Success
189           schema:
190             $ref: '#/definitions/DeploymentManagerGetDto'
191         "404":
192           description: Deployment manager not found
193   /o2ims-infrastructureInventory/v1/resourcePools:
194     get:
195       tags:
196       - O2IMS-InfrastructureInventory
197       operationId: Get Resource Pool List
198       parameters:
199       - name: filter
200         in: query
201         description: Filter of the query.
202         required: false
203         type: string
204       - name: exclude_default
205         in: query
206         description: "Exclude showing all default fields, Set \"true\" to enable."
207         required: false
208         type: string
209       - name: exclude_fields
210         in: query
211         description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
212         required: false
213         type: string
214       - name: fields
215         in: query
216         description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
217         required: false
218         type: string
219       - name: all_fields
220         in: query
221         description: Set any value for show all fields. This value will cover "fields" and "all_fields".
222         required: false
223         type: string
224       - name: nextpage_opaque_marker
225         in: query
226         description: "Page number of the results to fetch. Default: 1"
227         required: false
228         type: string
229         default: "1"
230       responses:
231         "200":
232           description: Success
233           schema:
234             type: array
235             items:
236               $ref: '#/definitions/ResourcePoolGetDto'
237   /o2ims-infrastructureInventory/v1/resourcePools/{resourcePoolID}:
238     get:
239       tags:
240       - O2IMS-InfrastructureInventory
241       operationId: Get Resource Pool Information
242       parameters:
243       - name: exclude_default
244         in: query
245         description: "Exclude showing all default fields, Set \"true\" to enable."
246         required: false
247         type: string
248       - name: exclude_fields
249         in: query
250         description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
251         required: false
252         type: string
253       - name: fields
254         in: query
255         description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
256         required: false
257         type: string
258       - name: all_fields
259         in: query
260         description: Set any value for show all fields. This value will cover "fields" and "all_fields".
261         required: false
262         type: string
263       - name: resourcePoolID
264         in: path
265         description: ID of the resource pool
266         required: true
267         type: string
268       responses:
269         "200":
270           description: Success
271           schema:
272             $ref: '#/definitions/ResourcePoolGetDto'
273         "404":
274           description: Resource pool not found
275   /o2ims-infrastructureInventory/v1/resourcePools/{resourcePoolID}/resources:
276     get:
277       tags:
278       - O2IMS-InfrastructureInventory
279       operationId: Get Resource List
280       parameters:
281       - name: filter
282         in: query
283         description: Filter of the query.
284         required: false
285         type: string
286       - name: exclude_default
287         in: query
288         description: "Exclude showing all default fields, Set \"true\" to enable."
289         required: false
290         type: string
291       - name: exclude_fields
292         in: query
293         description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
294         required: false
295         type: string
296       - name: fields
297         in: query
298         description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
299         required: false
300         type: string
301       - name: all_fields
302         in: query
303         description: Set any value for show all fields. This value will cover "fields" and "all_fields".
304         required: false
305         type: string
306       - name: nextpage_opaque_marker
307         in: query
308         description: "Page number of the results to fetch. Default: 1"
309         required: false
310         type: string
311         default: "1"
312       - name: resourcePoolID
313         in: path
314         description: ID of the resource pool
315         required: true
316         type: string
317       responses:
318         "200":
319           description: Success
320           schema:
321             type: array
322             items:
323               $ref: '#/definitions/ResourceListDto'
324         "404":
325           description: Resource pool not found
326   /o2ims-infrastructureInventory/v1/resourcePools/{resourcePoolID}/resources/{resourceID}:
327     get:
328       tags:
329       - O2IMS-InfrastructureInventory
330       operationId: Get Resource Information
331       parameters:
332       - name: exclude_default
333         in: query
334         description: "Exclude showing all default fields, Set \"true\" to enable."
335         required: false
336         type: string
337       - name: exclude_fields
338         in: query
339         description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
340         required: false
341         type: string
342       - name: fields
343         in: query
344         description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
345         required: false
346         type: string
347       - name: all_fields
348         in: query
349         description: Set any value for show all fields. This value will cover "fields" and "all_fields".
350         required: false
351         type: string
352       - name: resourceID
353         in: path
354         description: ID of the resource
355         required: true
356         type: string
357       - name: resourcePoolID
358         in: path
359         description: ID of the resource pool
360         required: true
361         type: string
362       responses:
363         "200":
364           description: Success
365           schema:
366             $ref: '#/definitions/ResourceGetDto2'
367         "404":
368           description: Resource not found
369   /o2ims-infrastructureInventory/v1/resourceTypes:
370     get:
371       tags:
372       - O2IMS-InfrastructureInventory
373       operationId: Get Resource Type List
374       parameters:
375       - name: filter
376         in: query
377         description: Filter of the query.
378         required: false
379         type: string
380       - name: exclude_default
381         in: query
382         description: "Exclude showing all default fields, Set \"true\" to enable."
383         required: false
384         type: string
385       - name: exclude_fields
386         in: query
387         description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
388         required: false
389         type: string
390       - name: fields
391         in: query
392         description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
393         required: false
394         type: string
395       - name: all_fields
396         in: query
397         description: Set any value for show all fields. This value will cover "fields" and "all_fields".
398         required: false
399         type: string
400       - name: nextpage_opaque_marker
401         in: query
402         description: "Page number of the results to fetch. Default: 1"
403         required: false
404         type: string
405         default: "1"
406       responses:
407         "200":
408           description: Success
409           schema:
410             type: array
411             items:
412               $ref: '#/definitions/ResourceTypeGetDto'
413   /o2ims-infrastructureInventory/v1/resourceTypes/{resourceTypeID}:
414     get:
415       tags:
416       - O2IMS-InfrastructureInventory
417       operationId: Get Resource Type Information
418       parameters:
419       - name: exclude_default
420         in: query
421         description: "Exclude showing all default fields, Set \"true\" to enable."
422         required: false
423         type: string
424       - name: exclude_fields
425         in: query
426         description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
427         required: false
428         type: string
429       - name: fields
430         in: query
431         description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
432         required: false
433         type: string
434       - name: all_fields
435         in: query
436         description: Set any value for show all fields. This value will cover "fields" and "all_fields".
437         required: false
438         type: string
439       - name: resourceTypeID
440         in: path
441         description: ID of the resource type
442         required: true
443         type: string
444       responses:
445         "200":
446           description: Success
447           schema:
448             $ref: '#/definitions/ResourceTypeGetDto'
449         "404":
450           description: Resource type not found
451   /o2ims-infrastructureInventory/v1/subscriptions:
452     get:
453       tags:
454       - O2IMS-InfrastructureInventory
455       operationId: Get Subscription List
456       parameters:
457       - name: filter
458         in: query
459         description: Filter of the query.
460         required: false
461         type: string
462       - name: exclude_default
463         in: query
464         description: "Exclude showing all default fields, Set \"true\" to enable."
465         required: false
466         type: string
467       - name: exclude_fields
468         in: query
469         description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
470         required: false
471         type: string
472       - name: fields
473         in: query
474         description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
475         required: false
476         type: string
477       - name: all_fields
478         in: query
479         description: Set any value for show all fields. This value will cover "fields" and "all_fields".
480         required: false
481         type: string
482       - name: nextpage_opaque_marker
483         in: query
484         description: "Page number of the results to fetch. Default: 1"
485         required: false
486         type: string
487         default: "1"
488       responses:
489         "200":
490           description: Success
491           schema:
492             type: array
493             items:
494               $ref: '#/definitions/SubscriptionGetDto'
495     post:
496       tags:
497       - O2IMS-InfrastructureInventory
498       operationId: Create a Subscription
499       parameters:
500       - in: body
501         name: payload
502         required: true
503         schema:
504           $ref: '#/definitions/SubscriptionCreateDto'
505       responses:
506         "201":
507           description: Success
508           schema:
509             $ref: '#/definitions/SubscriptionGetDto'
510   /o2ims-infrastructureInventory/v1/subscriptions/{subscriptionID}:
511     get:
512       tags:
513       - O2IMS-InfrastructureInventory
514       operationId: Get Subscription Information
515       parameters:
516       - name: subscriptionID
517         in: path
518         description: ID of the subscription
519         required: true
520         type: string
521       - name: exclude_default
522         in: query
523         description: "Exclude showing all default fields, Set \"true\" to enable."
524         required: false
525         type: string
526       - name: exclude_fields
527         in: query
528         description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
529         required: false
530         type: string
531       - name: fields
532         in: query
533         description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
534         required: false
535         type: string
536       - name: all_fields
537         in: query
538         description: Set any value for show all fields. This value will cover "fields" and "all_fields".
539         required: false
540         type: string
541       responses:
542         "200":
543           description: Success
544           schema:
545             $ref: '#/definitions/SubscriptionGetDto'
546         "404":
547           description: Subscription not found
548     delete:
549       tags:
550       - O2IMS-InfrastructureInventory
551       operationId: Delete a Subscription
552       parameters:
553       - name: subscriptionID
554         in: path
555         description: ID of the subscription
556         required: true
557         type: string
558       responses:
559         "200":
560           description: Subscription deleted
561         "404":
562           description: Subscription not found
563   /o2ims-infrastructureMonitoring/api_versions:
564     get:
565       tags:
566       - O2IMS-InfrastructureMonitoring
567       operationId: Get Monitoring Version
568       parameters: []
569       responses:
570         "200":
571           description: Success
572           schema:
573             $ref: '#/definitions/MonitoringAPIVersion'
574   /o2ims-infrastructureMonitoring/v1/alarmSubscriptions:
575     get:
576       tags:
577       - O2IMS-InfrastructureMonitoring
578       operationId: Get Alarm Subscription List
579       parameters:
580       - name: filter
581         in: query
582         description: Filter of the query.
583         required: false
584         type: string
585       - name: exclude_default
586         in: query
587         description: "Exclude showing all default fields, Set \"true\" to enable."
588         required: false
589         type: string
590       - name: exclude_fields
591         in: query
592         description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
593         required: false
594         type: string
595       - name: fields
596         in: query
597         description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
598         required: false
599         type: string
600       - name: all_fields
601         in: query
602         description: Set any value for show all fields. This value will cover "fields" and "all_fields".
603         required: false
604         type: string
605       - name: nextpage_opaque_marker
606         in: query
607         description: "Page number of the results to fetch. Default: 1"
608         required: false
609         type: string
610         default: "1"
611       responses:
612         "200":
613           description: Success
614           schema:
615             type: array
616             items:
617               $ref: '#/definitions/AlarmSubscriptionGetDto'
618     post:
619       tags:
620       - O2IMS-InfrastructureMonitoring
621       operationId: Create a Alarm Subscription
622       parameters:
623       - in: body
624         name: payload
625         required: true
626         schema:
627           $ref: '#/definitions/AlarmSubscriptionCreateDto'
628       responses:
629         "201":
630           description: Success
631           schema:
632             $ref: '#/definitions/AlarmSubscriptionGetDto'
633   /o2ims-infrastructureMonitoring/v1/alarmSubscriptions/{alarmSubscriptionID}:
634     get:
635       tags:
636       - O2IMS-InfrastructureMonitoring
637       operationId: Get Alarm Subscription Information
638       parameters:
639       - name: alarmSubscriptionID
640         in: path
641         description: ID of the Alarm Subscription
642         required: true
643         type: string
644       - name: exclude_default
645         in: query
646         description: "Exclude showing all default fields, Set \"true\" to enable."
647         required: false
648         type: string
649       - name: exclude_fields
650         in: query
651         description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
652         required: false
653         type: string
654       - name: fields
655         in: query
656         description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
657         required: false
658         type: string
659       - name: all_fields
660         in: query
661         description: Set any value for show all fields. This value will cover "fields" and "all_fields".
662         required: false
663         type: string
664       responses:
665         "200":
666           description: Success
667           schema:
668             $ref: '#/definitions/AlarmSubscriptionGetDto'
669         "404":
670           description: Alarm Subscription not found
671     delete:
672       tags:
673       - O2IMS-InfrastructureMonitoring
674       operationId: Delete an Alarm Subscription
675       parameters:
676       - name: alarmSubscriptionID
677         in: path
678         description: ID of the Alarm Subscription
679         required: true
680         type: string
681       responses:
682         "200":
683           description: Subscription deleted
684         "404":
685           description: Alarm Subscription not found
686   /o2ims-infrastructureMonitoring/v1/alarms:
687     get:
688       tags:
689       - O2IMS-InfrastructureMonitoring
690       operationId: Get Alarm Event Record List
691       parameters:
692       - name: filter
693         in: query
694         description: Filter of the query.
695         required: false
696         type: string
697       - name: exclude_default
698         in: query
699         description: "Exclude showing all default fields, Set \"true\" to enable."
700         required: false
701         type: string
702       - name: exclude_fields
703         in: query
704         description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
705         required: false
706         type: string
707       - name: fields
708         in: query
709         description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
710         required: false
711         type: string
712       - name: all_fields
713         in: query
714         description: Set any value for show all fields. This value will cover "fields" and "all_fields".
715         required: false
716         type: string
717       - name: nextpage_opaque_marker
718         in: query
719         description: "Page number of the results to fetch. Default: 1"
720         required: false
721         type: string
722         default: "1"
723       responses:
724         "200":
725           description: Success
726           schema:
727             type: array
728             items:
729               $ref: '#/definitions/AlarmGetDto'
730   /o2ims-infrastructureMonitoring/v1/alarms/{alarmEventRecordId}:
731     get:
732       tags:
733       - O2IMS-InfrastructureMonitoring
734       operationId: Get Alarm Event Record Information
735       parameters:
736       - name: exclude_default
737         in: query
738         description: "Exclude showing all default fields, Set \"true\" to enable."
739         required: false
740         type: string
741       - name: exclude_fields
742         in: query
743         description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
744         required: false
745         type: string
746       - name: fields
747         in: query
748         description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
749         required: false
750         type: string
751       - name: all_fields
752         in: query
753         description: Set any value for show all fields. This value will cover "fields" and "all_fields".
754         required: false
755         type: string
756       - name: alarmEventRecordId
757         in: path
758         description: ID of the alarm event record
759         required: true
760         type: string
761       responses:
762         "200":
763           description: Success
764           schema:
765             $ref: '#/definitions/AlarmGetDto'
766         "404":
767           description: Alarm Event Record not found
768   /o2ims-infrastructureMonitoring/v1/api_versions:
769     get:
770       tags:
771       - O2IMS-InfrastructureMonitoring
772       operationId: Get Monitoring API version
773       parameters: []
774       responses:
775         "200":
776           description: Success
777           schema:
778             type: array
779             items:
780               $ref: '#/definitions/MonitoringV1APIVersion'
781 definitions:
782   InventoryAPIVersion:
783     type: object
784     required:
785     - uriPrefix
786     properties:
787       uriPrefix:
788         type: string
789         example: https://128.224.115.36:30205/o2ims-infrastructureInventory
790         description: Specifies the URI prefix for the API
791       apiVersions:
792         type: array
793         example:
794         - version: 1.0.0
795         description: Version(s) supported for the API signaled by the uriPrefix attribute.
796         items:
797           $ref: '#/definitions/InventoryApiVersionStructure'
798     x-mask: "{uriPrefix,apiVersions}"
799   InventoryApiVersionStructure:
800     type: object
801     required:
802     - version
803     properties:
804       version:
805         type: string
806         example: 1.0.0
807         description: Identifies a supported version.
808     x-mask: "{version}"
809   InventoryV1APIVersion:
810     type: object
811     required:
812     - uriPrefix
813     properties:
814       uriPrefix:
815         type: string
816         example: https://128.224.115.36:30205/o2ims-infrastructureInventory/v1
817         description: Specifies the URI prefix for the API
818       apiVersions:
819         type: array
820         example:
821         - version: 1.0.0
822         description: Version(s) supported for the API signaled by the uriPrefix attribute.
823         items:
824           $ref: '#/definitions/InventoryV1ApiVersionStructure'
825     x-mask: "{uriPrefix,apiVersions}"
826   InventoryV1ApiVersionStructure:
827     type: object
828     required:
829     - version
830     properties:
831       version:
832         type: string
833         example: 1.0.0
834         description: Identifies a supported version.
835     x-mask: "{version}"
836   OcloudDto:
837     type: object
838     required:
839     - oCloudId
840     properties:
841       oCloudId:
842         type: string
843         example: f078a1d3-56df-46c2-88a2-dd659aa3f6bd
844         description: Identifier for the containing O-Cloud.
845       globalCloudId:
846         type: string
847         example: 10a07219-4201-4b3e-a52d-81ab6a755d8a
848         description: Identifier of the O-Cloud instance. Globally unique across O-Cloud instances.
849       globalcloudId:
850         type: string
851         example: 10a07219-4201-4b3e-a52d-81ab6a755d8a
852         description: Identifier of the O-Cloud instance. Globally unique across O-Cloud instances.(Specification)
853       name:
854         type: string
855         example: 95b818b8-b315-4d9f-af37-b82c492101f1
856         description: Human readable name of the O-Cloud.
857       description:
858         type: string
859         example: An ocloud
860         description: Human readable description of the O-Cloud.
861       serviceUri:
862         type: string
863         example: https://128.224.115.51:30205
864         description: The fully qualified URI root to all services provided by the O2ims interface
865       extensions:
866         type: string
867         example: ""
868         description: These are unspecified (not standardized) properties (keys) which are tailored by the vendor to extend the information provided about the O-Cloud.
869     x-mask: "{oCloudId,globalCloudId,globalcloudId,name,description,serviceUri}"
870   ResourceTypeGetDto:
871     type: object
872     required:
873     - resourceTypeId
874     properties:
875       resourceTypeId:
876         type: string
877         example: 60cba7be-e2cd-3b8c-a7ff-16e0f10573f9
878         description: Identifier for the Resource Type.
879       name:
880         type: string
881         example: pserver
882         description: Human readable name of the resource type.
883       description:
884         type: string
885         example: The Physical Server resource type
886         description: Human readable description of the resource type.
887       vendor:
888         type: string
889         example: ""
890         description: Provider of the Resource.
891       model:
892         type: string
893         example: ""
894         description: Information about the model of the resource as defined by its provider.
895       version:
896         type: string
897         example: ""
898         description: Version or generation of the resource as defined by its provider.
899       alarmDictionary:
900         $ref: '#/definitions/AlarmDictionaryDto'
901       extensions:
902         type: string
903         example: ""
904         description: List of metadata key-value pairs used to associate meaningful metadata to the related resource type.
905     x-mask: "{resourceTypeId,name,description,model,vendor,version}"
906   AlarmDictionaryDto:
907     type: object
908     properties:
909       id:
910         type: string
911         example: 7e1e59c3-c99e-3d1c-9934-21548a3a699a
912         description: Identifier for the Alarm Dictionary.
913       alarmDictionaryVersion:
914         type: string
915         example: "0.1"
916         description: Version of the Alarm Dictionary.
917       alarmDictionarySchemaVersion:
918         type: string
919         example: "0.1"
920         description: Version of the Alarm Dictionary Schema to which this alarm dictionary conforms.
921       entityType:
922         type: string
923         example: pserver
924         description: "O-RAN entity type emitting the alarm: This shall be unique per vendor ResourceType.model and ResourceType.version"
925       vendor:
926         type: string
927         example: ""
928         description: Vendor of the Entity Type to whom this Alarm Dictionary applies. This should be the same value as in the ResourceType.vendor attribute.
929       managementInterfaceId:
930         type: string
931         example: O2IMS
932         description: List of management interface over which alarms are transmitted for this Entity Type.
933       pkNotificationField:
934         type: string
935         example: ""
936         description: Identifies which field or list of fields in the alarm notification contains the primary key (PK) into the Alarm Dictionary for this interface; i.e. which field contains the Alarm Definition ID.
937       alarmDefinition:
938         type: array
939         example: ""
940         description: Contains the list of alarms that can be detected against this ResourceType.
941         items:
942           $ref: '#/definitions/AlarmDefinitionDto'
943   AlarmDefinitionDto:
944     type: object
945     properties:
946       alarmDefinitionId:
947         type: string
948         example: eaefa070-7cb6-3403-be46-177bd9ccc2d3
949         description: Provides a unique identifier of the alarm being raised.
950       alarmName:
951         type: string
952         example: "100.104"
953         description: Provides short name for the alarm.
954       alarmLastChange:
955         type: string
956         example: "0.1"
957         description: Indicates the Alarm Dictionary Version in which this alarm last changed.
958       alarmChangeType:
959         type: string
960         example: ADDED
961         description: "Indicates the type of change that occurred during the alarm last change; added, deleted, modified."
962       alarmDescription:
963         type: string
964         example: |-
965           host=<hostname>.filesystem=<mount-dir>
966               File System threshold exceeded; threshold x%, actual y% .
967                   CRITICAL @ 90%
968                   MAJOR    @ 80%
969           OR
970           host=<hostname>.volumegroup=<volumegroup-name>
971               Monitor and if condition persists, consider addin ...
972         description: Provides a longer descriptive meaning of the alarm condition and a description of the consequences of the alarm condition.
973       proposedRepairActions:
974         type: string
975         example: Reduce usage or resize filesystem.
976         description: Provides guidance for proposed repair actions.
977       clearingType:
978         type: string
979         example: MANUAL
980         description: Identifies whether alarm is cleared automatically or manually.
981       managementInterfaceId:
982         type: string
983         example: O2IMS
984         description: List of management interface over which alarms are transmitted for this Entity Type.
985       pkNotificationField:
986         type: string
987         example: ""
988         description: Identifies which field or list of fields in the alarm notification contains the primary key (PK) into the Alarm Dictionary for this interface; i.e. which field contains the Alarm Definition ID.
989       alarmAdditionalFields:
990         type: string
991         example: ""
992         description: List of metadata key-value pairs used to associate meaningful metadata to the related resource type.
993   ResourcePoolGetDto:
994     type: object
995     required:
996     - resourcePoolId
997     properties:
998       resourcePoolId:
999         type: string
1000         example: f078a1d3-56df-46c2-88a2-dd659aa3f6bd
1001         description: Identifier for the Resource Pool in the O-Cloud instance.
1002       globalLocationId:
1003         type: string
1004         example: ""
1005         description: This identifier is copied from the O-Cloud Id assigned by the SMO during the O-Cloud deployment.
1006       name:
1007         type: string
1008         example: RegionOne
1009         description: Human readable name of the resource pool.
1010       description:
1011         type: string
1012         example: A Resource Pool
1013         description: Human readable description of the resource pool.
1014       oCloudId:
1015         type: string
1016         example: f078a1d3-56df-46c2-88a2-dd659aa3f6bd
1017         description: Identifier for the containing O-Cloud.
1018       location:
1019         type: string
1020         example: ""
1021         description: Information about the geographical location of the resource pool as detected by the O-Cloud.
1022       extensions:
1023         type: string
1024         example: ""
1025         description: List of metadata key-value pairs used to associate meaningful metadata to the related resource pool.
1026     x-mask: "{resourcePoolId,oCloudId,globalLocationId,name,description}"
1027   ResourceListDto:
1028     type: object
1029     required:
1030     - resourceId
1031     properties:
1032       resourceId:
1033         type: string
1034         example: 5b3a2da8-17da-466c-b5f7-972590c7baf2
1035         description: Identifier for the Resource.
1036       resourceTypeId:
1037         type: string
1038         example: 60cba7be-e2cd-3b8c-a7ff-16e0f10573f9
1039         description: Identifier for the Resource Type of this resource.
1040       resourcePoolId:
1041         type: string
1042         example: f078a1d3-56df-46c2-88a2-dd659aa3f6bd
1043         description: Identifier of the Resource Pool containing this resource.
1044       globalAssetId:
1045         type: string
1046         example: ""
1047         description: Identifier or serial number of the resource.
1048       parentId:
1049         type: string
1050         example: None
1051         description: Identifier for the parent resource.
1052       description:
1053         type: string
1054         example: "id:1;hostname:controller-0;mgmt_mac:00:00:00:00:00:00;mgmt_ip:192.168.204.2;personality:controller;subfunctions:controller,worker;administrative:unlocked;operational:enabled;availability:available;clock_synchronization:ntp;capabilities:{'is_max_cpu_configurable': 'configurable', 'stor_function': 'monitor', 'Personality': 'Controller-Active'};boot_device:/dev/disk/by-path/pci-0000:02:00.0-scsi-0:1:0:0;rootfs_device:/dev/disk/by-path/pci-0000:02:00.0-scsi-0:1:0:0;software_load:22.12;install_state:None;max_cpu_mhz_allowed:None"
1055         description: Human readable description of the resource.
1056       extensions:
1057         type: object
1058         properties: {}
1059     x-mask: "{resourceId,resourcePoolId,resourceTypeId,description,parentId}"
1060   ResourceGetDto2:
1061     type: object
1062     required:
1063     - resourceId
1064     properties:
1065       resourceId:
1066         type: string
1067         example: eee8b101-6b7f-4f0a-b54b-89adc0f3f906
1068         description: Identifier for the Resource.
1069       resourceTypeId:
1070         type: string
1071         example: a45983bb-199a-30ec-b7a1-eab2455f333c
1072         description: Identifier for the Resource Type of this resource.
1073       resourcePoolId:
1074         type: string
1075         example: f078a1d3-56df-46c2-88a2-dd659aa3f6bd
1076         description: Identifier of the Resource Pool containing this resource.
1077       globalAssetId:
1078         type: string
1079         example: ""
1080         description: Identifier or serial number of the resource.
1081       parentId:
1082         type: string
1083         example: 5b3a2da8-17da-466c-b5f7-972590c7baf2
1084         description: Identifier for the parent resource.
1085       description:
1086         type: string
1087         example: cpu:0;core:0;thread:0;cpu_family:6;cpu_model:Intel(R) Xeon(R) CPU E5-2670 v2 @ 2.50GHz;allocated_function:Platform;numa_node:0
1088         description: Human readable description of the resource.
1089       extensions:
1090         type: object
1091         properties: {}
1092       elements:
1093         type: array
1094         items:
1095           $ref: '#/definitions/ResourceGetDto1'
1096     x-mask: "{resourceId,resourcePoolId,resourceTypeId,description,parentId}"
1097   ResourceGetDto1:
1098     type: object
1099     required:
1100     - resourceId
1101     properties:
1102       resourceId:
1103         type: string
1104         example: eee8b101-6b7f-4f0a-b54b-89adc0f3f906
1105         description: Identifier for the Resource.
1106       resourceTypeId:
1107         type: string
1108         example: a45983bb-199a-30ec-b7a1-eab2455f333c
1109         description: Identifier for the Resource Type of this resource.
1110       resourcePoolId:
1111         type: string
1112         example: f078a1d3-56df-46c2-88a2-dd659aa3f6bd
1113         description: Identifier of the Resource Pool containing this resource.
1114       globalAssetId:
1115         type: string
1116         example: ""
1117         description: Identifier or serial number of the resource.
1118       parentId:
1119         type: string
1120         example: 5b3a2da8-17da-466c-b5f7-972590c7baf2
1121         description: Identifier for the parent resource.
1122       description:
1123         type: string
1124         example: cpu:0;core:0;thread:0;cpu_family:6;cpu_model:Intel(R) Xeon(R) CPU E5-2670 v2 @ 2.50GHz;allocated_function:Platform;numa_node:0
1125         description: Human readable description of the resource.
1126       extensions:
1127         type: object
1128         properties: {}
1129       elements:
1130         type: array
1131         items:
1132           $ref: '#/definitions/ResourceGetDto0'
1133     x-mask: "{resourceId,resourcePoolId,resourceTypeId,description,parentId}"
1134   ResourceGetDto0:
1135     type: object
1136     required:
1137     - resourceId
1138     properties:
1139       resourceId:
1140         type: string
1141         example: eee8b101-6b7f-4f0a-b54b-89adc0f3f906
1142         description: Identifier for the Resource.
1143       resourceTypeId:
1144         type: string
1145         example: a45983bb-199a-30ec-b7a1-eab2455f333c
1146         description: Identifier for the Resource Type of this resource.
1147       resourcePoolId:
1148         type: string
1149         example: f078a1d3-56df-46c2-88a2-dd659aa3f6bd
1150         description: Identifier of the Resource Pool containing this resource.
1151       globalAssetId:
1152         type: string
1153         example: ""
1154         description: Identifier or serial number of the resource.
1155       parentId:
1156         type: string
1157         example: 5b3a2da8-17da-466c-b5f7-972590c7baf2
1158         description: Identifier for the parent resource.
1159       description:
1160         type: string
1161         example: cpu:0;core:0;thread:0;cpu_family:6;cpu_model:Intel(R) Xeon(R) CPU E5-2670 v2 @ 2.50GHz;allocated_function:Platform;numa_node:0
1162         description: Human readable description of the resource.
1163       extensions:
1164         type: object
1165         properties: {}
1166     x-mask: "{resourceId,resourcePoolId,resourceTypeId,description,parentId}"
1167   DeploymentManagerListDto:
1168     type: object
1169     required:
1170     - deploymentManagerId
1171     properties:
1172       deploymentManagerId:
1173         type: string
1174         example: c765516a-a84e-30c9-b954-9c3031bf71c8
1175         description: Identifier for the Deployment Manager.
1176       name:
1177         type: string
1178         example: 95b818b8-b315-4d9f-af37-b82c492101f1.kubernetes
1179         description: Human readable name of the deployment manager.
1180       description:
1181         type: string
1182         example: A DMS
1183         description: Human readable description of the deployment manager.
1184       oCloudId:
1185         type: string
1186         example: f078a1d3-56df-46c2-88a2-dd659aa3f6bd
1187         description: Identifier for the containing O-Cloud.
1188       serviceUri:
1189         type: string
1190         example: https://128.224.115.51:6443
1191         description: The fully qualified URI to a Deployment Management server for O2dms.
1192       capabilities:
1193         $ref: '#/definitions/DeploymentManagerCapabilities'
1194       profileSupportList:
1195         type: array
1196         example:
1197         - native_k8sapi
1198         description: "Profile support list, use default for the return endpoint"
1199         items:
1200           type: string
1201       extensions:
1202         type: string
1203         example: ""
1204         description: List of metadata key-value pairs used to associate meaningful metadata to the related Deployment Manager
1205     x-mask: "{deploymentManagerId,name,description,oCloudId,serviceUri,profileSupportList}"
1206   DeploymentManagerCapabilities:
1207     type: object
1208     properties:
1209       OS:
1210         type: string
1211         example: low_latency
1212         description: Show the OS capablities of the Deployment Manager
1213   DeploymentManagerGetDto:
1214     type: object
1215     required:
1216     - deploymentManagerId
1217     properties:
1218       deploymentManagerId:
1219         type: string
1220         example: c765516a-a84e-30c9-b954-9c3031bf71c8
1221         description: Identifier for the Deployment Manager.
1222       name:
1223         type: string
1224         example: 95b818b8-b315-4d9f-af37-b82c492101f1.kubernetes
1225         description: Human readable name of the deployment manager.
1226       description:
1227         type: string
1228         example: A DMS
1229         description: Human readable description of the deployment manager.
1230       oCloudId:
1231         type: string
1232         example: f078a1d3-56df-46c2-88a2-dd659aa3f6bd
1233         description: Identifier for the containing O-Cloud.
1234       serviceUri:
1235         type: string
1236         example: https://128.224.115.51:6443
1237         description: The fully qualified URI to a Deployment Management server for O2dms.
1238       capabilities:
1239         $ref: '#/definitions/DeploymentManagerCapabilities'
1240       extensions:
1241         $ref: '#/definitions/DeploymentManagerExtensions'
1242     x-mask: "{deploymentManagerId,name,description,oCloudId,serviceUri,extensions{profileName,profileData}}"
1243   DeploymentManagerExtensions:
1244     type: object
1245     properties:
1246       profileName:
1247         type: string
1248         example: ""
1249         description: ""
1250       profileData:
1251         $ref: '#/definitions/DeploymentManagerGetDtoProfile'
1252   DeploymentManagerGetDtoProfile:
1253     type: object
1254     properties:
1255       cluster_api_endpoint:
1256         type: string
1257         example: https://128.224.115.51:6443
1258         description: Kubernetes Cluster API Endpoint
1259       cluster_ca_cert:
1260         type: string
1261         example: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUZEakNDQX.....
1262         description: Kubernetes Cluster CA cert
1263       admin_user:
1264         type: string
1265         example: kubernetes-admin
1266         description: Kubernetes Admin username
1267       admin_client_cert:
1268         type: string
1269         example: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVJRENDQW.....
1270         description: Kubernetes Admin client cert
1271       admin_client_key:
1272         type: string
1273         example: LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpNSUlFcE.....
1274         description: Kubernetes Admin client key
1275       helmcli_host_with_port:
1276         type: string
1277         example: 128.224.115.34:30022
1278         description: Helm CLI Host address with SSH port
1279       helmcli_username:
1280         type: string
1281         example: helm
1282         description: Helm CLI SSH login username
1283       helmcli_password:
1284         type: string
1285         example: password
1286         description: Helm CLI SSH login password
1287       helmcli_kubeconfig:
1288         type: string
1289         example: /share/kubeconfig_c765516a.config
1290         description: Helm CLI KUBECONFIG path
1291   SubscriptionCreateDto:
1292     type: object
1293     required:
1294     - callback
1295     properties:
1296       callback:
1297         type: string
1298         example: https://128.224.115.15:1081/smo/v1/o2ims_inventory_observer
1299         description: Identifier for the Subscription.
1300       consumerSubscriptionId:
1301         type: string
1302         example: 3F20D850-AF4F-A84F-FB5A-0AD585410361
1303         description: Identifier for the consumer of events sent due to the Subscription.
1304       filter:
1305         type: string
1306         example: ""
1307         description: "Criteria for events which do not need to be reported or will be filtered by the subscription notification service. Therefore, if a filter is not provided then all events are reported."
1308   SubscriptionGetDto:
1309     type: object
1310     required:
1311     - subscriptionId
1312     properties:
1313       subscriptionId:
1314         type: string
1315         example: 0bea3e71-d2f7-4bf3-9c06-41d8d35806f9
1316         description: Identifier for the Subscription.
1317       callback:
1318         type: string
1319         example: https://128.224.115.15:1081/smo/v1/o2ims_inventory_observer
1320         description: The fully qualified URI to a consumer procedure which can process a Post of the InventoryEventNotification.
1321       consumerSubscriptionId:
1322         type: string
1323         example: 3F20D850-AF4F-A84F-FB5A-0AD585410361
1324         description: Identifier for the consumer of events sent due to the Subscription.
1325       filter:
1326         type: string
1327         example: ""
1328         description: "Criteria for events which do not need to be reported or will be filtered by the subscription notification service. Therefore, if a filter is not provided then all events are reported."
1329     x-mask: "{subscriptionId,callback}"
1330   MonitoringAPIVersion:
1331     type: object
1332     required:
1333     - uriPrefix
1334     properties:
1335       uriPrefix:
1336         type: string
1337         example: https://128.224.115.36:30205/o2ims-infrastructureMonitoring
1338         description: Specifies the URI prefix for the API
1339       apiVersions:
1340         type: array
1341         example:
1342         - version: 1.0.0
1343         description: Version(s) supported for the API signaled by the uriPrefix attribute.
1344         items:
1345           $ref: '#/definitions/MonitoringApiVersionStructure'
1346     x-mask: "{uriPrefix,apiVersions}"
1347   MonitoringApiVersionStructure:
1348     type: object
1349     required:
1350     - version
1351     properties:
1352       version:
1353         type: string
1354         example: 1.0.0
1355         description: Identifies a supported version.
1356     x-mask: "{version}"
1357   MonitoringV1APIVersion:
1358     type: object
1359     required:
1360     - uriPrefix
1361     properties:
1362       uriPrefix:
1363         type: string
1364         example: https://128.224.115.36:30205/o2ims-infrastructureMonitoring/v1
1365         description: Specifies the URI prefix for the API
1366       apiVersions:
1367         type: array
1368         example:
1369         - version: 1.0.0
1370         description: Version(s) supported for the API signaled by the uriPrefix attribute.
1371         items:
1372           $ref: '#/definitions/MonitoringV1ApiVersionStructure'
1373     x-mask: "{uriPrefix,apiVersions}"
1374   MonitoringV1ApiVersionStructure:
1375     type: object
1376     required:
1377     - version
1378     properties:
1379       version:
1380         type: string
1381         example: 1.0.0
1382         description: Identifies a supported version.
1383     x-mask: "{version}"
1384   AlarmGetDto:
1385     type: object
1386     required:
1387     - alarmEventRecordId
1388     properties:
1389       alarmEventRecordId:
1390         type: string
1391         example: 97cc2b01-0e71-4a93-a911-2e87f04d996f
1392         description: The identifier for the AlarmEventRecord Object.
1393       resourceTypeId:
1394         type: string
1395         example: 60cba7be-e2cd-3b8c-a7ff-16e0f10573f9
1396         description: A reference to the type of resource which caused the alarm.
1397       resourceTypeID:
1398         type: string
1399         example: 60cba7be-e2cd-3b8c-a7ff-16e0f10573f9
1400         description: A reference to the type of resource which caused the alarm.(Specification)
1401       resourceId:
1402         type: string
1403         example: 5b3a2da8-17da-466c-b5f7-972590c7baf2
1404         description: A reference to the resource instance which caused the alarm.
1405       resourceID:
1406         type: string
1407         example: 5b3a2da8-17da-466c-b5f7-972590c7baf2
1408         description: A reference to the resource instance which caused the alarm.(Specification)
1409       alarmDefinitionId:
1410         type: string
1411         example: 1197f463-b3d4-3aa3-9c14-faa493baa069
1412         description: A reference to the Alarm Definition record in the Alarm Dictionary associated with the referenced Resource Type.
1413       alarmDefinitionID:
1414         type: string
1415         example: 1197f463-b3d4-3aa3-9c14-faa493baa069
1416         description: A reference to the Alarm Definition record in the Alarm Dictionary associated with the referenced Resource Type.(Specification)
1417       probableCauseId:
1418         type: string
1419         example: f52054c9-6f3c-39a0-aab8-e00e01d8c4d3
1420         description: A reference to the ProbableCause of the Alarm.
1421       probableCauseID:
1422         type: string
1423         example: f52054c9-6f3c-39a0-aab8-e00e01d8c4d3
1424         description: A reference to the ProbableCause of the Alarm.(Specification)
1425       alarmRaisedTime:
1426         type: string
1427         example: 2022-12-22 09:42:53
1428         description: Date/Time stamp value when the AlarmEventRecord has been created.
1429       alarmChangedTime:
1430         type: string
1431         example: ""
1432         description: Date/Time stamp value when any value of the AlarmEventRecord has been modified.
1433       alarmAcknowledgeTime:
1434         type: string
1435         example: ""
1436         description: Date/Time stamp value when the alarm condition is acknowledged.
1437       alarmAcknowledged:
1438         type: boolean
1439         example: false
1440         description: Boolean value indicating of a management system has acknowledged the alarm.
1441       perceivedSeverity:
1442         type: string
1443         example: "1"
1444         description: "One of the following values: \n 0 for \"CRITICAL\" \n1 for \"MAJOR\" \n2 for \"MINOR\" \n3 for \"WARNING\" \n4 for \"INDETERMINATE\" \n5 for \"CLEARED\""
1445       extensions:
1446         type: object
1447         properties: {}
1448   AlarmSubscriptionCreateDto:
1449     type: object
1450     required:
1451     - callback
1452     properties:
1453       callback:
1454         type: string
1455         example: https://128.224.115.15:1081/smo/v1/o2ims_alarm_observer
1456         description: The fully qualified URI to a consumer procedure which can process a Post of the InventoryEventNotification.
1457       consumerSubscriptionId:
1458         type: string
1459         example: 3F20D850-AF4F-A84F-FB5A-0AD585410361
1460         description: Identifier for the consumer of events sent due to the Subscription.
1461       filter:
1462         type: string
1463         example: ""
1464         description: "Criteria for events which do not need to be reported or will be filtered by the subscription notification service. Therefore, if a filter is not provided then all events are reported."
1465   AlarmSubscriptionGetDto:
1466     type: object
1467     required:
1468     - alarmSubscriptionId
1469     properties:
1470       alarmSubscriptionId:
1471         type: string
1472         example: e320da6d-27a8-4948-8b52-3bf3355b45f3
1473         description: Identifier for the Alarm Subscription.
1474       callback:
1475         type: string
1476         example: https://128.224.115.15:1081/smo/v1/o2ims_alarm_observer
1477         description: The fully qualified URI to a consumer procedure which can process a Post of the InventoryEventNotification.
1478       consumerSubscriptionId:
1479         type: string
1480         example: 3F20D850-AF4F-A84F-FB5A-0AD585410361
1481         description: Identifier for the consumer of events sent due to the Subscription.
1482       filter:
1483         type: string
1484         example: ""
1485         description: "Criteria for events which do not need to be reported or will be filtered by the subscription notification service. Therefore, if a filter is not provided then all events are reported."
1486     x-mask: "{alarmSubscriptionId,callback}"
1487 responses:
1488   ParseError:
1489     description: When a mask can't be parsed
1490   MaskError:
1491     description: When any error occurs on mask
1492   HTTPException:
1493     description: Default error handler
1494   NotFound:
1495     description: notfound handler
1496   BadRequestException:
1497     description: Return a custom message and 400 status code
1498   NotFoundException:
1499     description: Return a custom message and 404 status code
1500   MethodNotAllowed:
1501     description: Return a custom message and 405 status code
1502   InternalServerError:
1503     description: Return a custom message and 500 status code
1504   Exception:
1505     description: Return a custom message and 500 status code