summaryrefslogtreecommitdiffstats
path: root/kubernetes/dcaegen2-services/resources/external/schemas/sa88-rel16/faultMnS.yaml
blob: e88231619b52d11e1128e5da36a926d42fbd2859 (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
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
openapi: 3.0.1
info:
  title: Fault Supervision MnS
  version: 16.4.0
  description: >-
    OAS 3.0.1 definition of the Fault Supervision MnS
    © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
    All rights reserved.
externalDocs:
  description: 3GPP TS 28.532 V16.4.0; Generic management services
  url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/
servers:
  - url: '{MnSRoot}/FaultSupervisionMnS/{version}'
    variables:
      MnSRoot:
        description: See subclause 4.4.3 of TS 32.158
        default: http://example.com/3GPPManagement
      version:
        description: Version number of the OpenAPI definition
        default: XXX
paths:
  /alarms:
    get:
      summary: Retrieve multiple alarms
      description: >-
        Retrieves the alarms identified by alarmAckState, baseObjectInstance
        and filter.
      parameters:
        - name: alarmAckState
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/AlarmAckState'
        - name: baseObjectInstance
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/Dn'
        - name: filter
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/Filter'
      responses:
        '200':
          description: >-
            Success case ("200 OK").
            Returns the alarms identified in the request. The alarmId is the key
            of the map.
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: object
                  allOf:
                      - type: object
                        properties:
                          lastNotificationHeader:
                            $ref: '#/components/schemas/NotificationHeader'
                      - $ref: '#/components/schemas/AlarmRecord'
                      - type: object
                        properties:
                          comments:
                            $ref: '#/components/schemas/Comments'
        default:
          description: Response in case of error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    patch:
      summary: 'Clear, acknowledge or unacknowledge multiple alarms'
      description: >-
        Clears, acknowledges or unacknowledges multiple alarms using patch. Depending
        on which action is to be performed, different merge patch documents need
        to be used.
      requestBody:
        description: >-
          Patch documents for acknowledging and unacknowledging, or clearing multiple
          alarms. The keys in the map are the alarmIds to be patched.
        content:
          application/merge-patch+json:
            schema:
              oneOf:
                - type: object
                  additionalProperties:
                    $ref: '#/components/schemas/MergePatchAcknowledgeAlarm'
                - type: object
                  additionalProperties:
                    $ref: '#/components/schemas/MergePatchClearAlarm'
      responses:
        '204':
          description: >-
            Success case ("204 No content").
            The response message body is empty.
        default:
          description: Response in case of error.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FailedAlarm'
  /alarms/alarmCount:
    get:
      summary: Get the alarm count per perceived severity
      parameters:
        - name: alarmAckState
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/AlarmAckState'
        - name: filter
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: >-
            Success case ("200 OK").
            The alarm count per perceived severity is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlarmCount'
        default:
          description: Response in case of error. The error case needs rework.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /alarms/{alarmId}:
    patch:
      summary: 'Clear, acknowledge or unacknowledge a single alarm'
      description: >-
        Clears, acknowledges or uncknowldeges a single alarm by patching the alarm
        information. A conditional acknowledge request based on the perceived
        severity is not supported.
      parameters:
        - name: alarmId
          in: path
          description: Identifies the alarm to be patched.
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/merge-patch+json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/MergePatchAcknowledgeAlarm'
                - $ref: '#/components/schemas/MergePatchClearAlarm'
      responses:
        '204':
          description: >-
            Success case (204 No content).
            The response message body is absent.
        default:
          description: Response in case of error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /alarms/{alarmId}/comments:
    post:
      summary: Add a comment to a single alarm
      description: >-
        Adds a comment to an alarm identified by alarmId. The id of the new comment
        is allocated by the producer.
      parameters:
        - name: alarmId
          in: path
          description: Identifies the alarm to which the comment shall be added.
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Comment'
      responses:
        '201':
          description: >-
            Success case (201 Created).
            The representation of the newly created comment resource shall be returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Comment'
          headers:
            Location:
              description: URI of the newly created comment resource.
              required: true
              schema:
                type: string
        default:
          description: Error case.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'

  /subscriptions:
    post:
      summary: Create a subscription
      description: >-
        To create a subscription the representation of the subscription is
        POSTed on the /subscriptions collection resource.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Subscription'
      responses:
        '201':
          description: >-
            Success case ("201 Created").
            The representation of the newly created subscription resource shall
            be returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
          headers:
            Location:
              description: URI of the newly created subscription resource
              required: true
              schema:
                type: string
        default:
          description: Error case.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      callbacks:
        notifyNewAlarm:
          '{request.body#/consumerReference}':
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      oneOf:
                        - $ref: '#/components/schemas/NotifyNewAlarm'
                        - $ref: '#/components/schemas/NotifyNewSecAlarm'
              responses:
                '204':
                  description: >-
                    Success case ("204 No Content").
                    The notification is successfully delivered. The response message
                    body is absent.
                default:
                  description: Error case.
                  content:
                    application/json:
                      schema:
                        $ref: '#/components/schemas/ErrorResponse'
        notifyClearedAlarm:
          '{request.body#/consumerReference}':
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/NotifyClearedAlarm'
              responses:
                '204':
                  description: >-
                    Success case ("204 No Content").
                    The notification is successfully delivered. The response message
                    body is absent.
                default:
                  description: Error case.
                  content:
                    application/json:
                      schema:
                        $ref: '#/components/schemas/ErrorResponse'
        notifyChangedAlarm:
          '{request.body#/consumerReference}':
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/NotifyChangedAlarm'
              responses:
                '204':
                  description: >-
                    Success case ("204 No Content").
                    The notification is successfully delivered. The response message
                    body is absent.
                default:
                  description: Error case.
                  content:
                    application/json:
                      schema:
                        $ref: '#/components/schemas/ErrorResponse'
        notifyChangedAlarmGeneral:
          '{request.body#/consumerReference}':
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      oneOf:
                        - $ref: '#/components/schemas/NotifyChangedAlarmGeneral'
                        - $ref: '#/components/schemas/NotifyChangedSecAlarmGeneral'
              responses:
                '204':
                  description: >-
                    Success case ("204 No Content").
                    The notification is successfully delivered. The response message
                    body is absent.
                default:
                  description: Error case.
                  content:
                    application/json:
                      schema:
                        $ref: '#/components/schemas/ErrorResponse'
        notifyCorrelatedNotificationChanged:
          '{request.body#/consumerReference}':
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/NotifyCorrelatedNotificationChanged'
              responses:
                '204':
                  description: >-
                    Success case ("204 No Content").
                    The notification is successfully delivered. The response message
                    body is absent.
                default:
                  description: Error case.
                  content:
                    application/json:
                      schema:
                        $ref: '#/components/schemas/ErrorResponse'
        notifyAckStateChanged:
          '{request.body#/consumerReference}':
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/NotifyAckStateChanged'
              responses:
                '204':
                  description: >-
                    Success case ("204 No Content").
                    The notification is successfully delivered. The response message
                    body is absent.
                default:
                  description: Error case.
                  content:
                    application/json:
                      schema:
                        $ref: '#/components/schemas/ErrorResponse'
        notifyComments:
          '{request.body#/consumerReference}':
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/NotifyComments'
              responses:
                '204':
                  description: >-
                    Success case ("204 No Content").
                    The notification is successfully delivered. The response message
                    body is absent.
                default:
                  description: Error case.
                  content:
                    application/json:
                      schema:
                        $ref: '#/components/schemas/ErrorResponse'
        notifyPotentialFaultyAlarmList:
          '{request.body#/consumerReference}':
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/NotifyPotentialFaultyAlarmList'
              responses:
                '204':
                  description: >-
                    Success case ("204 No Content").
                    The notification is successfully delivered. The response message
                    body is absent.
                default:
                  description: Error case.
                  content:
                    application/json:
                      schema:
                        $ref: '#/components/schemas/ErrorResponse'
        notifyAlarmListRebuilt:
          '{request.body#/consumerReference}':
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/NotifyAlarmListRebuilt'
              responses:
                '204':
                  description: >-
                    Success case ("204 No Content").
                    The notification is successfully delivered. The response message
                    body is absent.
                default:
                  description: Error case.
                  content:
                    application/json:
                      schema:
                        $ref: '#/components/schemas/ErrorResponse'
  /subscriptions/{subscriptionId}:
    delete:
      summary: Delete a subscription
      description: >-
        The subscription is deleted by deleting the corresponding subscription
        resource. The resource to be deleted is identified with the path
        component of the URI.
      parameters:
        - name: subscriptionId
          in: path
          description: Identifies the subscription to be deleted.
          required: true
          schema:
            type: string
      responses:
        '204':
          description: >-
            Success case ("204 No Content").
            The subscription resource has been deleted. The response message body
            is absent.
        default:
          description: Error case.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'

components:
  schemas:

  #---- Definitions to be moved to comDefs.yaml --------------------------------------#

    Long:
      type: string
      format: long
    Float:
      type: string
      format: float
    DateTime:
      type: string
      format: date-Time

    Dn:
      type: string
    Uri:
      type: string

    AttributeNameValuePairSet:
      type: object
      minProperties: 1
    AttributeValueChangeSet:
      description: >-
        The key in this map is the attribute name. The value of each key is an array.
        When only one item is present in the array, it carries the new attribute
        value. If two items are present, then the first item carries the old value
        and the second item the new value. The items can be of any type including null.
      type: object
      additionalProperties:
        type: array
        minItems: 1
        maxItems: 2
        items:
          nullable: true

    Filter:
      type: string
    SystemDN:
      type: string

    NotificationId:
      type: integer
    NotificationHeader:
      description: >-
        Header used for all notification types
      type: object
      required:
        - href
        - notificationId
        - notificationType
        - eventTime
        - systemDN
      properties:
        uri:
          $ref: '#/components/schemas/Uri'
        notificationId:
          $ref: '#/components/schemas/NotificationId'
        notificationType:
          oneOf:
            - $ref: '#/components/schemas/AlarmNotificationTypes'
            #- $ref: 'faultMnS.yaml#/components/schemas/AlarmNotificationTypes'
            #- $ref: 'provMnS.yaml#/components/schemas/CmNotificationTypes'
            # more to be added
        eventTime:
          $ref: '#/components/schemas/DateTime'
        systemDN:
          $ref: '#/components/schemas/SystemDN'

    ErrorResponse:
      description: >-
        Default schema for the response message body in case the request is not
        successful.
      type: object
      properties:
        error:
          type: object
          properties:
            errorInfo:
              type: string

  #---- End of definitions to be moved to comDefs.yaml -------------------------------#

  #---- Definition of AlarmRecord ----------------------------------------------------#

    AlarmId:
      type: string
    AlarmType:
      type: string
      enum:
        - COMMUNICATIONS_ALARM
        - QUALITY_OF_SERVICE_ALARM
        - PROCESSING_ERROR_ALARM
        - EQUIPMENT_ALARM
        - ENVIRONMENTAL_ALARM
        - INTEGRITY_VIOLATION
        - OPERATIONAL_VIOLATION
        - PHYSICAL_VIOLATION
        - SECURITY_SERVICE_OR_MECHANISM_VIOLATION
        - TIME_DOMAIN_VIOLATION
    ProbableCause:
      description: >-
        The value of the probable cause may be a specific standardized string, or any
        vendor provided string. Probable cause strings are not standardized in the
        present document. They may be added in a future version. Up to then the
        mapping of the generic probable cause strings "PROBABLE_CAUSE_001" to
        "PROBABLE_CAUSE_005" is vendor specific.
        The value of the probable cause may also be an integer. The mapping of integer
        values to probable causes is vendor specific.
      oneOf:
        - anyOf:
            - type: string
              enum:
                - PROBABLE_CAUSE_001
                - PROBABLE_CAUSE_002
                - PROBABLE_CAUSE_003
                - PROBABLE_CAUSE_004
                - PROBABLE_CAUSE_005
            - type: string
        - type: integer
    SpecificProblem:
      oneOf:
        - type: string
        - type: integer
    PerceivedSeverity:
      type: string
      enum:
        - INDETERMINATE
        - CRITICAL
        - MAJOR
        - MINOR
        - WARNING
        - CLEARED
    TrendIndication:
      type: string
      enum:
        - MORE_SEVERE
        - NO_CHANGE
        - LESS_SEVERE
    ThresholdHysteresis:
      type: object
      required:
        - high
      properties:
        high:
          oneOf:
            - type: integer
            - $ref: '#/components/schemas/Float'
        low:
          $ref: '#/components/schemas/Float'
    ThresholdLevelInd:
      type: object
      required:
        - up
      properties:
        up:
          $ref: '#/components/schemas/ThresholdHysteresis'
        low:
          $ref: '#/components/schemas/ThresholdHysteresis'
    ThresholdInfo:
      type: object
      required:
        - observedMeasurement
        - observedValue
      properties:
        observedMeasurement:
          type: string
        observedValue:
          oneOf:
            - type: integer
            - $ref: '#/components/schemas/Float'
        thresholdLevelInd:
          $ref: '#/components/schemas/ThresholdLevelInd'
        armTime:
          $ref: '#/components/schemas/DateTime'
    CorrelatedNotification:
      type: object
      required:
        - source
        - notificationId
      properties:
        sourceObjectInstance:
          $ref: '#/components/schemas/Dn'
        notificationIds:
          type: array
          items:
            $ref: '#/components/schemas/NotificationId'
    CorrelatedNotifications:
      type: array
      items:
        $ref: '#/components/schemas/CorrelatedNotification'
    AckState:
      type: string
      enum:
        - ACKNOWLEDGED
        - UNACKNOWLEDGED

    AlarmRecord:
      description: >-
        The alarmId is not a property of an alarm record. It is used as key
        in the map of alarm records instead.
      type: object
      properties:
        # alarmId:
        #  $ref: '#/components/schemas/AlarmId'
        objectInstance:
          $ref: '#/components/schemas/Dn'
        notificationId:
          $ref: '#/components/schemas/NotificationId'
        alarmRaisedTime:
          $ref: '#/components/schemas/DateTime'
        alarmChangedTime:
          $ref: '#/components/schemas/DateTime'
        alarmClearedTime:
          $ref: '#/components/schemas/DateTime'
        alarmType:
          $ref: '#/components/schemas/AlarmType'
        probableCause:
          $ref: '#/components/schemas/ProbableCause'
        specificProblem:
          $ref: '#/components/schemas/SpecificProblem'
        perceivedSeverity:
          $ref: '#/components/schemas/PerceivedSeverity'
        backedUpStatus:
          type: boolean
        backUpObject:
          $ref: '#/components/schemas/Dn'
        trendIndication:
          $ref: '#/components/schemas/TrendIndication'
        thresholdinfo:
          $ref: '#/components/schemas/ThresholdInfo'
        correlatedNotifications:
          $ref: '#/components/schemas/CorrelatedNotifications'
        stateChangeDefinition:
          $ref: '#/components/schemas/AttributeValueChangeSet'
        monitoredAttributes:
          $ref: '#/components/schemas/AttributeNameValuePairSet'
        proposedRepairActions:
          type: string
        additionalText:
          type: string
        additionalInformation:
          $ref: '#/components/schemas/AttributeNameValuePairSet'

        rootCauseIndicator:
          type: boolean

        ackTime:
          $ref: '#/components/schemas/DateTime'
        ackUserId:
          type: string
        ackSystemId:
          type: string
        ackState:
          $ref: '#/components/schemas/AckState'

        clearUserId:
          type: string
        clearSystemId:
          type: string
        serviceUser:
          type: string
        serviceProvider:
          type: string
        securityAlarmDetector:
          type: string

  #---- Definition of alarm notifications --------------------------------------------#

    AlarmNotificationTypes:
      type: string
      enum:
        - notifyNewAlarm
        - notifyChangedAlarm
        - notifyChangedAlarmGeneral
        - notifyAckStateChanged
        - notifyCorrelatedNotificationChanged
        - notifyComments
        - notifyClearedAlarm
        - notifyAlarmListRebuiltAlarm
        - notifyPotentialFaultyAlarmList
    AlarmListAlignmentRequirement:
      type: string
      enum:
        - ALIGNMENT_REQUIRED
        - ALIGNMENT_NOT_REQUIRED

    NotifyNewAlarm:
      allOf:
        - $ref: '#/components/schemas/NotificationHeader'
        - type: object
          required:
            - alarmId
            - alarmType
            - probableCause
            - perceivedSeverity
          properties:
            alarmId:
              $ref: '#/components/schemas/AlarmId'
            alarmType:
              $ref: '#/components/schemas/AlarmType'
            probableCause:
              $ref: '#/components/schemas/ProbableCause'
            specificProblem:
              $ref: '#/components/schemas/SpecificProblem'
            perceivedSeverity:
              $ref: '#/components/schemas/PerceivedSeverity'
            backedUpStatus:
              type: boolean
            backUpObject:
              $ref: '#/components/schemas/Dn'
            trendIndication:
              $ref: '#/components/schemas/TrendIndication'
            thresholdInfo:
              $ref: '#/components/schemas/ThresholdInfo'
            correlatedNotifications:
              $ref: '#/components/schemas/CorrelatedNotifications'
            stateChangeDefinition:
              $ref: '#/components/schemas/AttributeValueChangeSet'
            monitoredAttributes:
              $ref: '#/components/schemas/AttributeNameValuePairSet'
            proposedRepairActions:
              type: string
            additionalText:
              type: string
            additionalInformation:
              $ref: '#/components/schemas/AttributeNameValuePairSet'
            rootCauseIndicator:
              type: boolean
    NotifyNewSecAlarm:
      allOf:
        - $ref: '#/components/schemas/NotificationHeader'
        - type: object
          required:
            - alarmId
            - alarmType
            - probableCause
            - perceivedSeverity
            - serviceUser
            - serviceProvider
            - securityAlarmDetector
          properties:
            alarmId:
              $ref: '#/components/schemas/AlarmId'
            alarmType:
              $ref: '#/components/schemas/AlarmType'
            probableCause:
              $ref: '#/components/schemas/ProbableCause'
            perceivedSeverity:
              $ref: '#/components/schemas/PerceivedSeverity'
            correlatedNotifications:
              $ref: '#/components/schemas/CorrelatedNotifications'
            additionalText:
              type: string
            additionalInformation:
              $ref: '#/components/schemas/AttributeNameValuePairSet'
            rootCauseIndicator:
              type: boolean
            serviceUser:
              type: string
            serviceProvider:
              type: string
            securityAlarmDetector:
              type: string
    NotifyClearedAlarm:
      allOf:
        - $ref: '#/components/schemas/NotificationHeader'
        - type: object
          required:
            - alarmId
            - alarmType
            - probableCause
            - perceivedSeverity
          properties:
            alarmId:
              $ref: '#/components/schemas/AlarmId'
            alarmType:
              $ref: '#/components/schemas/AlarmType'
            probableCause:
              $ref: '#/components/schemas/ProbableCause'
            perceivedSeverity:
              $ref: '#/components/schemas/PerceivedSeverity'
            correlatedNotifications:
              $ref: '#/components/schemas/CorrelatedNotifications'
            clearUserId:
              type: string
            clearSystemId:
              type: string
    NotifyChangedAlarm:
      allOf:
        - $ref: '#/components/schemas/NotificationHeader'
        - type: object
          required:
            - alarmId
            - alarmType
            - probableCause
            - perceivedSeverity
          properties:
            alarmId:
              $ref: '#/components/schemas/AlarmId'
            alarmType:
              $ref: '#/components/schemas/AlarmType'
            probableCause:
              $ref: '#/components/schemas/ProbableCause'
            perceivedSeverity:
              $ref: '#/components/schemas/PerceivedSeverity'
    NotifyChangedAlarmGeneral:
      allOf:
        - $ref: '#/components/schemas/NotificationHeader'
        - type: object
          required:
            - alarmId
            - alarmType
            - probableCause
            - perceivedSeverity
            - changedAlarmAttributes
          properties:
            alarmId:
              $ref: '#/components/schemas/AlarmId'
            alarmType:
              $ref: '#/components/schemas/AlarmType'
            probableCause:
              $ref: '#/components/schemas/ProbableCause'
            specificProblem:
              $ref: '#/components/schemas/SpecificProblem'
            perceivedSeverity:
              $ref: '#/components/schemas/PerceivedSeverity'
            correlatedNotifications:
              $ref: '#/components/schemas/CorrelatedNotifications'
            backedUpStatus:
              type: boolean
            backUpObject:
              $ref: '#/components/schemas/Dn'
            trendIndication:
              $ref: '#/components/schemas/TrendIndication'
            thresholdInfo:
              $ref: '#/components/schemas/ThresholdInfo'
            stateChangeDefinition:
              $ref: '#/components/schemas/AttributeValueChangeSet'
            monitoredAttributes:
              $ref: '#/components/schemas/AttributeNameValuePairSet'
            proposedRepairActions:
              type: string
            additionalText:
              type: string
            additionalInformation:
              $ref: '#/components/schemas/AttributeNameValuePairSet'
            rootCauseIndicator:
              type: boolean
            changedAlarmAttributes:
              $ref: '#/components/schemas/AttributeNameValuePairSet'
    NotifyChangedSecAlarmGeneral:
      allOf:
        - $ref: '#/components/schemas/NotificationHeader'
        - type: object
          required:
            - alarmId
            - alarmType
            - probableCause
            - perceivedSeverity
            - serviceUser
            - serviceProvider
            - securityAlarmDetector
            - changedAlarmAttributes
          properties:
            alarmId:
              $ref: '#/components/schemas/AlarmId'
            alarmType:
              $ref: '#/components/schemas/AlarmType'
            probableCause:
              $ref: '#/components/schemas/ProbableCause'
            perceivedSeverity:
              $ref: '#/components/schemas/PerceivedSeverity'
            correlatedNotifications:
              $ref: '#/components/schemas/CorrelatedNotifications'
            additionalText:
              type: string
            additionalInformation:
              $ref: '#/components/schemas/AttributeNameValuePairSet'
            rootCauseIndicator:
              type: boolean
            serviceUser:
              type: string
            serviceProvider:
              type: string
            securityAlarmDetector:
              type: string
            changedAlarmAttributes:
              $ref: '#/components/schemas/AttributeNameValuePairSet'
    NotifyCorrelatedNotificationChanged:
      allOf:
        - $ref: '#/components/schemas/NotificationHeader'
        - type: object
          required:
            - alarmId
            - correlatedNotifications
          properties:
            alarmId:
              $ref: '#/components/schemas/AlarmId'
            correlatedNotifications:
              $ref: '#/components/schemas/CorrelatedNotifications'
            rootCauseIndicator:
              type: boolean
    NotifyAckStateChanged:
      allOf:
        - $ref: '#/components/schemas/NotificationHeader'
        - type: object
          required:
            - alarmId
            - alarmType
            - probableCause
            - perceivedSeverity
            - ackState
            - ackUserId
          properties:
            alarmId:
              $ref: '#/components/schemas/AlarmId'
            alarmType:
              $ref: '#/components/schemas/AlarmType'
            probableCause:
              $ref: '#/components/schemas/ProbableCause'
            perceivedSeverity:
              $ref: '#/components/schemas/PerceivedSeverity'
            ackState:
              $ref: '#/components/schemas/AckState'
            ackUserId:
              type: string
            ackSystemId:
              type: string
    NotifyComments:
      allOf:
        - $ref: '#/components/schemas/NotificationHeader'
        - type: object
          required:
            - alarmId
            - alarmType
            - probableCause
            - perceivedSeverity
            - comments
          properties:
            alarmId:
              $ref: '#/components/schemas/AlarmId'
            alarmType:
              $ref: '#/components/schemas/AlarmType'
            probableCause:
              $ref: '#/components/schemas/ProbableCause'
            perceivedSeverity:
              $ref: '#/components/schemas/PerceivedSeverity'
            comments:
              $ref: '#/components/schemas/Comments'
    NotifyPotentialFaultyAlarmList:
      allOf:
        - $ref: '#/components/schemas/NotificationHeader'
        - type: object
          required:
            - reason
          properties:
            reason:
              type: string
    NotifyAlarmListRebuilt:
      allOf:
        - $ref: '#/components/schemas/NotificationHeader'
        - type: object
          required:
            - reason
          properties:
            reason:
              type: string
            alarmListAlignmentRequirement:
              $ref: '#/components/schemas/AlarmListAlignmentRequirement'

  #---- Definition of query parameters -----------------------------------------------#

    AlarmAckState:
      type: string
      enum:
        - ALL_ALARMS
        - ALL_ACTIVE_ALARMS
        - ALL_ACTIVE_AND_ACKNOWLEDGED_ALARMS
        - ALL_ACTIVE_AND_UNACKNOWLEDGED_ALARMS
        - ALL_CLEARED_AND_UNACKNOWLEDGED_ALARMS
        - ALL_UNACKNOWLEDGED_ALARMS

  #---- Definition of patch documents ------------------------------------------------#

    MergePatchAcknowledgeAlarm:
      description: >-
        Patch document acknowledging or unacknowledging a single alarm. For
        acknowleding an alarm the value of ackState is ACKNOWLEDGED, for unacknowleding
        an alarm the value of ackState is UNACKNOWLEDGED.
      type: object
      required:
        - ackUserId
        - ackState
      properties:
        ackUserId:
          type: string
        ackSystemId:
          type: string
        ackState:
          $ref: '#/components/schemas/AckState'
    MergePatchClearAlarm:
      description: Patch document for clearing a single alarm
      type: object
      required:
        - clearUserId
        - perceivedSeverity
      properties:
        clearUserId:
          type: string
        clearSystemId:
          type: string
        perceivedSeverity:
          type: string
          enum:
            - CLEARED

  #---- Definition of method responses -----------------------------------------------#

    FailedAlarm:
      type: object
      required:
        - alarmId
        - failureReason
      properties:
        alarmId:
          $ref: '#/components/schemas/AlarmId'
        failureReason:
          type: string

  #---- Definition of resources ------------------------------------------------------#

    AlarmCount:
      type: object
      required:
        - criticalCount
        - majorCount
        - minorCount
        - warningCount
        - indeterminateCount
        - clearedCount
      properties:
        criticalCount:
          type: integer
        majorCount:
          type: integer
        minorCount:
          type: integer
        warningCount:
          type: integer
        indeterminateCount:
          type: integer
        clearedCount:
          type: integer
    Comment:
      type: object
      properties:
        commentTime:
          $ref: '#/components/schemas/DateTime'
        commentUserId:
          type: string
        commentSystemId:
          type: string
        commentText:
          type: string
    Comments:
      description: >-
        Collection of comments. The comment identifiers are allocated by the
        MnS producer and used as key in the map.
      type: object
      additionalProperties:
        $ref: '#/components/schemas/Comment'
    Subscription:
      type: object
      properties:
        consumerReference:
          $ref: '#/components/schemas/Uri'
        timeTick:
          $ref: '#/components/schemas/Long'
        filter:
          $ref: '#/components/schemas/Filter'