kubernetes/dcaegen2-services/resources/external/schemas/sa91-rel16/faultMnS.yaml

   1 openapi: 3.0.1
   2 info:
   3   title: Fault Supervision MnS
   4   version: 16.6.0
   5   description: >-
   6     OAS 3.0.1 definition of the Fault Supervision MnS
   7     © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
   8     All rights reserved.
   9 externalDocs:
  10   description: 3GPP TS 28.532; Generic management services
  11   url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/
  12 servers:
  13   - url: '{MnSRoot}/FaultSupervisionMnS/{MnSversion}'
  14     variables:
  15       MnSRoot:
  16         description: See subclause 4.4.3 of TS 32.158
  17         default: http://example.com/3GPPManagement
  18       MnSversion:
  19         description: Version number of the OpenAPI definition
  20         default: XXX
  21 paths:
  22   /alarms:
  23     get:
  24       summary: Retrieve multiple alarms
  25       description: >-
  26         Retrieves the alarms identified by alarmAckState, baseObjectInstance
  27         and filter.
  28       parameters:
  29         - name: alarmAckState
  30           in: query
  31           required: false
  32           schema:
  33             $ref: '#/components/schemas/AlarmAckState'
  34         - name: baseObjectInstance
  35           in: query
  36           required: false
  37           schema:
  38             $ref: 'comDefs.yaml#/components/schemas/Dn'
  39         - name: filter
  40           in: query
  41           required: false
  42           schema:
  43             $ref: 'comDefs.yaml#/components/schemas/Filter'
  44       responses:
  45         '200':
  46           description: >-
  47             Success case ("200 OK").
  48             Returns the alarms identified in the request. The alarmId is the key
  49             of the map.
  50           content:
  51             application/json:
  52               schema:
  53                 type: object
  54                 additionalProperties:
  55                   type: object
  56                   allOf:
  57                       - type: object
  58                         properties:
  59                           lastNotificationHeader:
  60                             $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
  61                       - $ref: '#/components/schemas/AlarmRecord'
  62                       - type: object
  63                         properties:
  64                           comments:
  65                             $ref: '#/components/schemas/Comments'
  66         default:
  67           description: Response in case of error.
  68           content:
  69             application/json:
  70               schema:
  71                 $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
  72     patch:
  73       summary: 'Clear, acknowledge or unacknowledge multiple alarms'
  74       description: >-
  75         Clears, acknowledges or unacknowledges multiple alarms using patch. Depending
  76         on which action is to be performed, different merge patch documents need
  77         to be used.
  78       requestBody:
  79         description: >-
  80           Patch documents for acknowledging and unacknowledging, or clearing multiple
  81           alarms. The keys in the map are the alarmIds to be patched.
  82         content:
  83           application/merge-patch+json:
  84             schema:
  85               oneOf:
  86                 - type: object
  87                   additionalProperties:
  88                     $ref: '#/components/schemas/MergePatchAcknowledgeAlarm'
  89                 - type: object
  90                   additionalProperties:
  91                     $ref: '#/components/schemas/MergePatchClearAlarm'
  92       responses:
  93         '204':
  94           description: >-
  95             Success case ("204 No content").
  96             The response message body is empty.
  97         default:
  98           description: Response in case of error.
  99           content:
 100             application/json:
 101               schema:
 102                 type: array
 103                 items:
 104                   $ref: '#/components/schemas/FailedAlarm'
 105   /alarms/alarmCount:
 106     get:
 107       summary: Get the alarm count per perceived severity
 108       parameters:
 109         - name: alarmAckState
 110           in: query
 111           required: false
 112           schema:
 113             $ref: '#/components/schemas/AlarmAckState'
 114         - name: filter
 115           in: query
 116           required: false
 117           schema:
 118             type: string
 119       responses:
 120         '200':
 121           description: >-
 122             Success case ("200 OK").
 123             The alarm count per perceived severity is returned.
 124           content:
 125             application/json:
 126               schema:
 127                 $ref: '#/components/schemas/AlarmCount'
 128         default:
 129           description: Response in case of error. The error case needs rework.
 130           content:
 131             application/json:
 132               schema:
 133                 $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
 134   /alarms/{alarmId}:
 135     patch:
 136       summary: 'Clear, acknowledge or unacknowledge a single alarm'
 137       description: >-
 138         Clears, acknowledges or uncknowldeges a single alarm by patching the alarm
 139         information. A conditional acknowledge request based on the perceived
 140         severity is not supported.
 141       parameters:
 142         - name: alarmId
 143           in: path
 144           description: Identifies the alarm to be patched.
 145           required: true
 146           schema:
 147             type: string
 148       requestBody:
 149         required: true
 150         content:
 151           application/merge-patch+json:
 152             schema:
 153               oneOf:
 154                 - $ref: '#/components/schemas/MergePatchAcknowledgeAlarm'
 155                 - $ref: '#/components/schemas/MergePatchClearAlarm'
 156       responses:
 157         '204':
 158           description: >-
 159             Success case (204 No content).
 160             The response message body is absent.
 161         default:
 162           description: Response in case of error.
 163           content:
 164             application/json:
 165               schema:
 166                 $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
 167   /alarms/{alarmId}/comments:
 168     post:
 169       summary: Add a comment to a single alarm
 170       description: >-
 171         Adds a comment to an alarm identified by alarmId. The id of the new comment
 172         is allocated by the producer.
 173       parameters:
 174         - name: alarmId
 175           in: path
 176           description: Identifies the alarm to which the comment shall be added.
 177           required: true
 178           schema:
 179             type: string
 180       requestBody:
 181         required: true
 182         content:
 183           application/json:
 184             schema:
 185               $ref: '#/components/schemas/Comment'
 186       responses:
 187         '201':
 188           description: >-
 189             Success case (201 Created).
 190             The representation of the newly created comment resource shall be returned.
 191           content:
 192             application/json:
 193               schema:
 194                 $ref: '#/components/schemas/Comment'
 195           headers:
 196             Location:
 197               description: URI of the newly created comment resource.
 198               required: true
 199               schema:
 200                 type: string
 201         default:
 202           description: Error case.
 203           content:
 204             application/json:
 205               schema:
 206                 $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
 207
 208   /subscriptions:
 209     post:
 210       summary: Create a subscription
 211       description: >-
 212         To create a subscription the representation of the subscription is
 213         POSTed on the /subscriptions collection resource.
 214       requestBody:
 215         required: true
 216         content:
 217           application/json:
 218             schema:
 219               $ref: '#/components/schemas/Subscription'
 220       responses:
 221         '201':
 222           description: >-
 223             Success case ("201 Created").
 224             The representation of the newly created subscription resource shall
 225             be returned.
 226           content:
 227             application/json:
 228               schema:
 229                 $ref: '#/components/schemas/Subscription'
 230           headers:
 231             Location:
 232               description: URI of the newly created subscription resource
 233               required: true
 234               schema:
 235                 type: string
 236         default:
 237           description: Error case.
 238           content:
 239             application/json:
 240               schema:
 241                 $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
 242       callbacks:
 243         notifyNewAlarm:
 244           '{request.body#/consumerReference}':
 245             post:
 246               requestBody:
 247                 required: true
 248                 content:
 249                   application/json:
 250                     schema:
 251                       oneOf:
 252                         - $ref: '#/components/schemas/NotifyNewAlarm'
 253                         - $ref: '#/components/schemas/NotifyNewSecAlarm'
 254               responses:
 255                 '204':
 256                   description: >-
 257                     Success case ("204 No Content").
 258                     The notification is successfully delivered. The response message
 259                     body is absent.
 260                 default:
 261                   description: Error case.
 262                   content:
 263                     application/json:
 264                       schema:
 265                         $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
 266         notifyClearedAlarm:
 267           '{request.body#/consumerReference}':
 268             post:
 269               requestBody:
 270                 required: true
 271                 content:
 272                   application/json:
 273                     schema:
 274                       $ref: '#/components/schemas/NotifyClearedAlarm'
 275               responses:
 276                 '204':
 277                   description: >-
 278                     Success case ("204 No Content").
 279                     The notification is successfully delivered. The response message
 280                     body is absent.
 281                 default:
 282                   description: Error case.
 283                   content:
 284                     application/json:
 285                       schema:
 286                         $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
 287         notifyChangedAlarm:
 288           '{request.body#/consumerReference}':
 289             post:
 290               requestBody:
 291                 required: true
 292                 content:
 293                   application/json:
 294                     schema:
 295                       $ref: '#/components/schemas/NotifyChangedAlarm'
 296               responses:
 297                 '204':
 298                   description: >-
 299                     Success case ("204 No Content").
 300                     The notification is successfully delivered. The response message
 301                     body is absent.
 302                 default:
 303                   description: Error case.
 304                   content:
 305                     application/json:
 306                       schema:
 307                         $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
 308         notifyChangedAlarmGeneral:
 309           '{request.body#/consumerReference}':
 310             post:
 311               requestBody:
 312                 required: true
 313                 content:
 314                   application/json:
 315                     schema:
 316                       oneOf:
 317                         - $ref: '#/components/schemas/NotifyChangedAlarmGeneral'
 318                         - $ref: '#/components/schemas/NotifyChangedSecAlarmGeneral'
 319               responses:
 320                 '204':
 321                   description: >-
 322                     Success case ("204 No Content").
 323                     The notification is successfully delivered. The response message
 324                     body is absent.
 325                 default:
 326                   description: Error case.
 327                   content:
 328                     application/json:
 329                       schema:
 330                         $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
 331         notifyCorrelatedNotificationChanged:
 332           '{request.body#/consumerReference}':
 333             post:
 334               requestBody:
 335                 required: true
 336                 content:
 337                   application/json:
 338                     schema:
 339                       $ref: '#/components/schemas/NotifyCorrelatedNotificationChanged'
 340               responses:
 341                 '204':
 342                   description: >-
 343                     Success case ("204 No Content").
 344                     The notification is successfully delivered. The response message
 345                     body is absent.
 346                 default:
 347                   description: Error case.
 348                   content:
 349                     application/json:
 350                       schema:
 351                         $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
 352         notifyAckStateChanged:
 353           '{request.body#/consumerReference}':
 354             post:
 355               requestBody:
 356                 required: true
 357                 content:
 358                   application/json:
 359                     schema:
 360                       $ref: '#/components/schemas/NotifyAckStateChanged'
 361               responses:
 362                 '204':
 363                   description: >-
 364                     Success case ("204 No Content").
 365                     The notification is successfully delivered. The response message
 366                     body is absent.
 367                 default:
 368                   description: Error case.
 369                   content:
 370                     application/json:
 371                       schema:
 372                         $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
 373         notifyComments:
 374           '{request.body#/consumerReference}':
 375             post:
 376               requestBody:
 377                 required: true
 378                 content:
 379                   application/json:
 380                     schema:
 381                       $ref: '#/components/schemas/NotifyComments'
 382               responses:
 383                 '204':
 384                   description: >-
 385                     Success case ("204 No Content").
 386                     The notification is successfully delivered. The response message
 387                     body is absent.
 388                 default:
 389                   description: Error case.
 390                   content:
 391                     application/json:
 392                       schema:
 393                         $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
 394         notifyPotentialFaultyAlarmList:
 395           '{request.body#/consumerReference}':
 396             post:
 397               requestBody:
 398                 required: true
 399                 content:
 400                   application/json:
 401                     schema:
 402                       $ref: '#/components/schemas/NotifyPotentialFaultyAlarmList'
 403               responses:
 404                 '204':
 405                   description: >-
 406                     Success case ("204 No Content").
 407                     The notification is successfully delivered. The response message
 408                     body is absent.
 409                 default:
 410                   description: Error case.
 411                   content:
 412                     application/json:
 413                       schema:
 414                         $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
 415         notifyAlarmListRebuilt:
 416           '{request.body#/consumerReference}':
 417             post:
 418               requestBody:
 419                 required: true
 420                 content:
 421                   application/json:
 422                     schema:
 423                       $ref: '#/components/schemas/NotifyAlarmListRebuilt'
 424               responses:
 425                 '204':
 426                   description: >-
 427                     Success case ("204 No Content").
 428                     The notification is successfully delivered. The response message
 429                     body is absent.
 430                 default:
 431                   description: Error case.
 432                   content:
 433                     application/json:
 434                       schema:
 435                         $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
 436   /subscriptions/{subscriptionId}:
 437     delete:
 438       summary: Delete a subscription
 439       description: >-
 440         The subscription is deleted by deleting the corresponding subscription
 441         resource. The resource to be deleted is identified with the path
 442         component of the URI.
 443       parameters:
 444         - name: subscriptionId
 445           in: path
 446           description: Identifies the subscription to be deleted.
 447           required: true
 448           schema:
 449             type: string
 450       responses:
 451         '204':
 452           description: >-
 453             Success case ("204 No Content").
 454             The subscription resource has been deleted. The response message body
 455             is absent.
 456         default:
 457           description: Error case.
 458           content:
 459             application/json:
 460               schema:
 461                 $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
 462
 463 components:
 464   schemas:
 465
 466   #---- Definition of AlarmRecord ----------------------------------------------------#
 467
 468     AlarmId:
 469       type: string
 470     AlarmType:
 471       type: string
 472       enum:
 473         - COMMUNICATIONS_ALARM
 474         - QUALITY_OF_SERVICE_ALARM
 475         - PROCESSING_ERROR_ALARM
 476         - EQUIPMENT_ALARM
 477         - ENVIRONMENTAL_ALARM
 478         - INTEGRITY_VIOLATION
 479         - OPERATIONAL_VIOLATION
 480         - PHYSICAL_VIOLATION
 481         - SECURITY_SERVICE_OR_MECHANISM_VIOLATION
 482         - TIME_DOMAIN_VIOLATION
 483     ProbableCause:
 484       description: >-
 485         The value of the probable cause may be a specific standardized string, or any
 486         vendor provided string. Probable cause strings are not standardized in the
 487         present document. They may be added in a future version. Up to then the
 488         mapping of the generic probable cause strings "PROBABLE_CAUSE_001" to
 489         "PROBABLE_CAUSE_005" is vendor specific.
 490         The value of the probable cause may also be an integer. The mapping of integer
 491         values to probable causes is vendor specific.
 492       oneOf:
 493         - anyOf:
 494             - type: string
 495               enum:
 496                 - PROBABLE_CAUSE_001
 497                 - PROBABLE_CAUSE_002
 498                 - PROBABLE_CAUSE_003
 499                 - PROBABLE_CAUSE_004
 500                 - PROBABLE_CAUSE_005
 501             - type: string
 502         - type: integer
 503     SpecificProblem:
 504       oneOf:
 505         - type: string
 506         - type: integer
 507     PerceivedSeverity:
 508       type: string
 509       enum:
 510         - INDETERMINATE
 511         - CRITICAL
 512         - MAJOR
 513         - MINOR
 514         - WARNING
 515         - CLEARED
 516     TrendIndication:
 517       type: string
 518       enum:
 519         - MORE_SEVERE
 520         - NO_CHANGE
 521         - LESS_SEVERE
 522     ThresholdHysteresis:
 523       type: object
 524       required:
 525         - high
 526       properties:
 527         high:
 528           oneOf:
 529             - type: integer
 530             - $ref: 'comDefs.yaml#/components/schemas/Float'
 531         low:
 532           $ref: 'comDefs.yaml#/components/schemas/Float'
 533     ThresholdLevelInd:
 534       oneOf:
 535         - type: object
 536           properties:
 537             up:
 538               $ref: '#/components/schemas/ThresholdHysteresis'
 539         - type: object
 540           properties:
 541             down:
 542               $ref: '#/components/schemas/ThresholdHysteresis'
 543     ThresholdInfo:
 544       type: object
 545       properties:
 546         observedMeasurement:
 547           type: string
 548         observedValue:
 549           oneOf:
 550             - type: integer
 551             - $ref: 'comDefs.yaml#/components/schemas/Float'
 552         thresholdLevel:
 553           $ref: '#/components/schemas/ThresholdLevelInd'
 554         armTime:
 555           $ref: 'comDefs.yaml#/components/schemas/DateTime'
 556       required:
 557         - observedMeasurement
 558         - observedValue
 559     CorrelatedNotification:
 560       type: object
 561       properties:
 562         sourceObjectInstance:
 563           $ref: 'comDefs.yaml#/components/schemas/Dn'
 564         notificationIds:
 565           type: array
 566           items:
 567             $ref: 'comDefs.yaml#/components/schemas/NotificationId'
 568       required:
 569         - sourceObjectInstance
 570         - notificationIds
 571     CorrelatedNotifications:
 572       type: array
 573       items:
 574         $ref: '#/components/schemas/CorrelatedNotification'
 575     AckState:
 576       type: string
 577       enum:
 578         - ACKNOWLEDGED
 579         - UNACKNOWLEDGED
 580
 581     AlarmRecord:
 582       description: >-
 583         The alarmId is not a property of an alarm record. It is used as key
 584         in the map of alarm records instead.
 585       type: object
 586       properties:
 587         # alarmId:
 588         #  $ref: '#/components/schemas/AlarmId'
 589         objectInstance:
 590           $ref: 'comDefs.yaml#/components/schemas/Dn'
 591         notificationId:
 592           $ref: 'comDefs.yaml#/components/schemas/NotificationId'
 593         alarmRaisedTime:
 594           $ref: 'comDefs.yaml#/components/schemas/DateTime'
 595         alarmChangedTime:
 596           $ref: 'comDefs.yaml#/components/schemas/DateTime'
 597         alarmClearedTime:
 598           $ref: 'comDefs.yaml#/components/schemas/DateTime'
 599         alarmType:
 600           $ref: '#/components/schemas/AlarmType'
 601         probableCause:
 602           $ref: '#/components/schemas/ProbableCause'
 603         specificProblem:
 604           $ref: '#/components/schemas/SpecificProblem'
 605         perceivedSeverity:
 606           $ref: '#/components/schemas/PerceivedSeverity'
 607         backedUpStatus:
 608           type: boolean
 609         backUpObject:
 610           $ref: 'comDefs.yaml#/components/schemas/Dn'
 611         trendIndication:
 612           $ref: '#/components/schemas/TrendIndication'
 613         thresholdinfo:
 614           $ref: '#/components/schemas/ThresholdInfo'
 615         correlatedNotifications:
 616           $ref: '#/components/schemas/CorrelatedNotifications'
 617         stateChangeDefinition:
 618           $ref: 'comDefs.yaml#/components/schemas/AttributeValueChangeSet'
 619         monitoredAttributes:
 620           $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
 621         proposedRepairActions:
 622           type: string
 623         additionalText:
 624           type: string
 625         additionalInformation:
 626           $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
 627
 628         rootCauseIndicator:
 629           type: boolean
 630
 631         ackTime:
 632           $ref: 'comDefs.yaml#/components/schemas/DateTime'
 633         ackUserId:
 634           type: string
 635         ackSystemId:
 636           type: string
 637         ackState:
 638           $ref: '#/components/schemas/AckState'
 639
 640         clearUserId:
 641           type: string
 642         clearSystemId:
 643           type: string
 644         serviceUser:
 645           type: string
 646         serviceProvider:
 647           type: string
 648         securityAlarmDetector:
 649           type: string
 650
 651   #---- Definition of alarm notifications --------------------------------------------#
 652
 653     AlarmNotificationTypes:
 654       type: string
 655       enum:
 656         - notifyNewAlarm
 657         - notifyChangedAlarm
 658         - notifyChangedAlarmGeneral
 659         - notifyAckStateChanged
 660         - notifyCorrelatedNotificationChanged
 661         - notifyComments
 662         - notifyClearedAlarm
 663         - notifyAlarmListRebuiltAlarm
 664         - notifyPotentialFaultyAlarmList
 665     AlarmListAlignmentRequirement:
 666       type: string
 667       enum:
 668         - ALIGNMENT_REQUIRED
 669         - ALIGNMENT_NOT_REQUIRED
 670
 671     NotifyNewAlarm:
 672       allOf:
 673         - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
 674         - type: object
 675           required:
 676             - alarmId
 677             - alarmType
 678             - probableCause
 679             - perceivedSeverity
 680           properties:
 681             alarmId:
 682               $ref: '#/components/schemas/AlarmId'
 683             alarmType:
 684               $ref: '#/components/schemas/AlarmType'
 685             probableCause:
 686               $ref: '#/components/schemas/ProbableCause'
 687             specificProblem:
 688               $ref: '#/components/schemas/SpecificProblem'
 689             perceivedSeverity:
 690               $ref: '#/components/schemas/PerceivedSeverity'
 691             backedUpStatus:
 692               type: boolean
 693             backUpObject:
 694               $ref: 'comDefs.yaml#/components/schemas/Dn'
 695             trendIndication:
 696               $ref: '#/components/schemas/TrendIndication'
 697             thresholdInfo:
 698               $ref: '#/components/schemas/ThresholdInfo'
 699             correlatedNotifications:
 700               $ref: '#/components/schemas/CorrelatedNotifications'
 701             stateChangeDefinition:
 702               $ref: 'comDefs.yaml#/components/schemas/AttributeValueChangeSet'
 703             monitoredAttributes:
 704               $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
 705             proposedRepairActions:
 706               type: string
 707             additionalText:
 708               type: string
 709             additionalInformation:
 710               $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
 711             rootCauseIndicator:
 712               type: boolean
 713     NotifyNewSecAlarm:
 714       allOf:
 715         - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
 716         - type: object
 717           required:
 718             - alarmId
 719             - alarmType
 720             - probableCause
 721             - perceivedSeverity
 722             - serviceUser
 723             - serviceProvider
 724             - securityAlarmDetector
 725           properties:
 726             alarmId:
 727               $ref: '#/components/schemas/AlarmId'
 728             alarmType:
 729               $ref: '#/components/schemas/AlarmType'
 730             probableCause:
 731               $ref: '#/components/schemas/ProbableCause'
 732             perceivedSeverity:
 733               $ref: '#/components/schemas/PerceivedSeverity'
 734             correlatedNotifications:
 735               $ref: '#/components/schemas/CorrelatedNotifications'
 736             additionalText:
 737               type: string
 738             additionalInformation:
 739               $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
 740             rootCauseIndicator:
 741               type: boolean
 742             serviceUser:
 743               type: string
 744             serviceProvider:
 745               type: string
 746             securityAlarmDetector:
 747               type: string
 748     NotifyClearedAlarm:
 749       allOf:
 750         - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
 751         - type: object
 752           required:
 753             - alarmId
 754             - alarmType
 755             - probableCause
 756             - perceivedSeverity
 757           properties:
 758             alarmId:
 759               $ref: '#/components/schemas/AlarmId'
 760             alarmType:
 761               $ref: '#/components/schemas/AlarmType'
 762             probableCause:
 763               $ref: '#/components/schemas/ProbableCause'
 764             perceivedSeverity:
 765               $ref: '#/components/schemas/PerceivedSeverity'
 766             correlatedNotifications:
 767               $ref: '#/components/schemas/CorrelatedNotifications'
 768             clearUserId:
 769               type: string
 770             clearSystemId:
 771               type: string
 772     NotifyChangedAlarm:
 773       allOf:
 774         - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
 775         - type: object
 776           required:
 777             - alarmId
 778             - alarmType
 779             - probableCause
 780             - perceivedSeverity
 781           properties:
 782             alarmId:
 783               $ref: '#/components/schemas/AlarmId'
 784             alarmType:
 785               $ref: '#/components/schemas/AlarmType'
 786             probableCause:
 787               $ref: '#/components/schemas/ProbableCause'
 788             perceivedSeverity:
 789               $ref: '#/components/schemas/PerceivedSeverity'
 790     NotifyChangedAlarmGeneral:
 791       allOf:
 792         - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
 793         - type: object
 794           required:
 795             - alarmId
 796             - alarmType
 797           properties:
 798             alarmId:
 799               $ref: '#/components/schemas/AlarmId'
 800             alarmType:
 801               $ref: '#/components/schemas/AlarmType'
 802             probableCause:
 803               $ref: '#/components/schemas/ProbableCause'
 804             specificProblem:
 805               $ref: '#/components/schemas/SpecificProblem'
 806             perceivedSeverity:
 807               $ref: '#/components/schemas/PerceivedSeverity'
 808             correlatedNotifications:
 809               $ref: '#/components/schemas/CorrelatedNotifications'
 810             backedUpStatus:
 811               type: boolean
 812             backUpObject:
 813               $ref: 'comDefs.yaml#/components/schemas/Dn'
 814             trendIndication:
 815               $ref: '#/components/schemas/TrendIndication'
 816             thresholdInfo:
 817               $ref: '#/components/schemas/ThresholdInfo'
 818             stateChangeDefinition:
 819               $ref: 'comDefs.yaml#/components/schemas/AttributeValueChangeSet'
 820             monitoredAttributes:
 821               $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
 822             proposedRepairActions:
 823               type: string
 824             additionalText:
 825               type: string
 826             additionalInformation:
 827               $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
 828             rootCauseIndicator:
 829               type: boolean
 830             changedAlarmAttributes:
 831               $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
 832     NotifyChangedSecAlarmGeneral:
 833       allOf:
 834         - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
 835         - type: object
 836           required:
 837             - alarmId
 838             - alarmType
 839             - serviceUser
 840             - serviceProvider
 841             - securityAlarmDetector
 842           properties:
 843             alarmId:
 844               $ref: '#/components/schemas/AlarmId'
 845             alarmType:
 846               $ref: '#/components/schemas/AlarmType'
 847             probableCause:
 848               $ref: '#/components/schemas/ProbableCause'
 849             perceivedSeverity:
 850               $ref: '#/components/schemas/PerceivedSeverity'
 851             correlatedNotifications:
 852               $ref: '#/components/schemas/CorrelatedNotifications'
 853             additionalText:
 854               type: string
 855             additionalInformation:
 856               $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
 857             rootCauseIndicator:
 858               type: boolean
 859             serviceUser:
 860               type: string
 861             serviceProvider:
 862               type: string
 863             securityAlarmDetector:
 864               type: string
 865             changedAlarmAttributes:
 866               $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
 867     NotifyCorrelatedNotificationChanged:
 868       allOf:
 869         - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
 870         - type: object
 871           required:
 872             - alarmId
 873             - correlatedNotifications
 874           properties:
 875             alarmId:
 876               $ref: '#/components/schemas/AlarmId'
 877             correlatedNotifications:
 878               $ref: '#/components/schemas/CorrelatedNotifications'
 879             rootCauseIndicator:
 880               type: boolean
 881     NotifyAckStateChanged:
 882       allOf:
 883         - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
 884         - type: object
 885           required:
 886             - alarmId
 887             - alarmType
 888             - probableCause
 889             - perceivedSeverity
 890             - ackState
 891             - ackUserId
 892           properties:
 893             alarmId:
 894               $ref: '#/components/schemas/AlarmId'
 895             alarmType:
 896               $ref: '#/components/schemas/AlarmType'
 897             probableCause:
 898               $ref: '#/components/schemas/ProbableCause'
 899             perceivedSeverity:
 900               $ref: '#/components/schemas/PerceivedSeverity'
 901             ackState:
 902               $ref: '#/components/schemas/AckState'
 903             ackUserId:
 904               type: string
 905             ackSystemId:
 906               type: string
 907     NotifyComments:
 908       allOf:
 909         - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
 910         - type: object
 911           required:
 912             - alarmId
 913             - alarmType
 914             - probableCause
 915             - perceivedSeverity
 916             - comments
 917           properties:
 918             alarmId:
 919               $ref: '#/components/schemas/AlarmId'
 920             alarmType:
 921               $ref: '#/components/schemas/AlarmType'
 922             probableCause:
 923               $ref: '#/components/schemas/ProbableCause'
 924             perceivedSeverity:
 925               $ref: '#/components/schemas/PerceivedSeverity'
 926             comments:
 927               $ref: '#/components/schemas/Comments'
 928     NotifyPotentialFaultyAlarmList:
 929       allOf:
 930         - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
 931         - type: object
 932           required:
 933             - reason
 934           properties:
 935             reason:
 936               type: string
 937     NotifyAlarmListRebuilt:
 938       allOf:
 939         - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
 940         - type: object
 941           required:
 942             - reason
 943           properties:
 944             reason:
 945               type: string
 946             alarmListAlignmentRequirement:
 947               $ref: '#/components/schemas/AlarmListAlignmentRequirement'
 948
 949   #---- Definition of query parameters -----------------------------------------------#
 950
 951     AlarmAckState:
 952       type: string
 953       enum:
 954         - ALL_ALARMS
 955         - ALL_ACTIVE_ALARMS
 956         - ALL_ACTIVE_AND_ACKNOWLEDGED_ALARMS
 957         - ALL_ACTIVE_AND_UNACKNOWLEDGED_ALARMS
 958         - ALL_CLEARED_AND_UNACKNOWLEDGED_ALARMS
 959         - ALL_UNACKNOWLEDGED_ALARMS
 960
 961   #---- Definition of patch documents ------------------------------------------------#
 962
 963     MergePatchAcknowledgeAlarm:
 964       description: >-
 965         Patch document acknowledging or unacknowledging a single alarm. For
 966         acknowleding an alarm the value of ackState is ACKNOWLEDGED, for unacknowleding
 967         an alarm the value of ackState is UNACKNOWLEDGED.
 968       type: object
 969       required:
 970         - ackUserId
 971         - ackState
 972       properties:
 973         ackUserId:
 974           type: string
 975         ackSystemId:
 976           type: string
 977         ackState:
 978           $ref: '#/components/schemas/AckState'
 979     MergePatchClearAlarm:
 980       description: Patch document for clearing a single alarm
 981       type: object
 982       required:
 983         - clearUserId
 984         - perceivedSeverity
 985       properties:
 986         clearUserId:
 987           type: string
 988         clearSystemId:
 989           type: string
 990         perceivedSeverity:
 991           type: string
 992           enum:
 993             - CLEARED
 994
 995   #---- Definition of method responses -----------------------------------------------#
 996
 997     FailedAlarm:
 998       type: object
 999       required:
1000         - alarmId
1001         - failureReason
1002       properties:
1003         alarmId:
1004           $ref: '#/components/schemas/AlarmId'
1005         failureReason:
1006           type: string
1007
1008   #---- Definition of resources ------------------------------------------------------#
1009
1010     AlarmCount:
1011       type: object
1012       required:
1013         - criticalCount
1014         - majorCount
1015         - minorCount
1016         - warningCount
1017         - indeterminateCount
1018         - clearedCount
1019       properties:
1020         criticalCount:
1021           type: integer
1022         majorCount:
1023           type: integer
1024         minorCount:
1025           type: integer
1026         warningCount:
1027           type: integer
1028         indeterminateCount:
1029           type: integer
1030         clearedCount:
1031           type: integer
1032     Comment:
1033       type: object
1034       properties:
1035         commentTime:
1036           $ref: 'comDefs.yaml#/components/schemas/DateTime'
1037         commentUserId:
1038           type: string
1039         commentSystemId:
1040           type: string
1041         commentText:
1042           type: string
1043     Comments:
1044       description: >-
1045         Collection of comments. The comment identifiers are allocated by the
1046         MnS producer and used as key in the map.
1047       type: object
1048       additionalProperties:
1049         $ref: '#/components/schemas/Comment'
1050     Subscription:
1051       type: object
1052       properties:
1053         consumerReference:
1054           $ref: 'comDefs.yaml#/components/schemas/Uri'
1055         timeTick:
1056           type: integer
1057         filter:
1058           $ref: 'comDefs.yaml#/components/schemas/Filter'