tests/dcaegen2/testcases/assets/test_schemas/externalRepo/3gpp/rep/sa5/MnS/blob/SA88-Rel16/OpenAPI/faultMnS_wrong_file_reference.yaml

   1 openapi: 3.0.1
   2 info:
   3   title: Fault Supervision MnS
   4   version: 16.5.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 V16.5.0; Generic management services
  11   url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/
  12 servers:
  13   - url: '{MnSRoot}/FaultSupervisionMnS/{version}'
  14     variables:
  15       MnSRoot:
  16         description: See subclause 4.4.3 of TS 32.158
  17         default: http://example.com/3GPPManagement
  18       version:
  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       type: object
 535       required:
 536         - up
 537       properties:
 538         up:
 539           $ref: '#/components/schemas/ThresholdHysteresis'
 540         low:
 541           $ref: '#/components/schemas/ThresholdHysteresis'
 542     ThresholdInfo:
 543       type: object
 544       required:
 545         - observedMeasurement
 546         - observedValue
 547       properties:
 548         observedMeasurement:
 549           type: string
 550         observedValue:
 551           type: integer
 552           oneOf:
 553             - $ref: 'comDefs.yaml#/components/schemas/Float'
 554         thresholdLevelInd:
 555           $ref: '#/components/schemas/ThresholdLevelInd'
 556         armTime:
 557           $ref: 'comDefs.yaml#/components/schemas/DateTime'
 558     CorrelatedNotification:
 559       type: object
 560       required:
 561         - source
 562         - notificationId
 563       properties:
 564         sourceObjectInstance:
 565           $ref: 'comDefs.yaml#/components/schemas/Dn'
 566         notificationIds:
 567           type: array
 568           items:
 569             $ref: 'comDefs.yaml#/components/schemas/NotificationId'
 570     CorrelatedNotifications:
 571       type: array
 572       items:
 573         $ref: '#/components/schemas/CorrelatedNotification'
 574     AckState:
 575       type: string
 576       enum:
 577         - ACKNOWLEDGED
 578         - UNACKNOWLEDGED
 579
 580     AlarmRecord:
 581       description: >-
 582         The alarmId is not a property of an alarm record. It is used as key
 583         in the map of alarm records instead.
 584       type: object
 585       properties:
 586         # alarmId:
 587         #  $ref: '#/components/schemas/AlarmId'
 588         objectInstance:
 589           $ref: 'comDefs.yaml#/components/schemas/Dn'
 590         notificationId:
 591           $ref: 'comDefs.yaml#/components/schemas/NotificationId'
 592         alarmRaisedTime:
 593           $ref: 'comDefs.yaml#/components/schemas/DateTime'
 594         alarmChangedTime:
 595           $ref: 'comDefs.yaml#/components/schemas/DateTime'
 596         alarmClearedTime:
 597           $ref: 'comDefs.yaml#/components/schemas/DateTime'
 598         alarmType:
 599           $ref: '#/components/schemas/AlarmType'
 600         probableCause:
 601           $ref: '#/components/schemas/ProbableCause'
 602         specificProblem:
 603           $ref: '#/components/schemas/SpecificProblem'
 604         perceivedSeverity:
 605           $ref: '#/components/schemas/PerceivedSeverity'
 606         backedUpStatus:
 607           type: boolean
 608         backUpObject:
 609           $ref: 'comDefs.yaml#/components/schemas/Dn'
 610         trendIndication:
 611           $ref: '#/components/schemas/TrendIndication'
 612         thresholdinfo:
 613           $ref: '#/components/schemas/ThresholdInfo'
 614         correlatedNotifications:
 615           $ref: '#/components/schemas/CorrelatedNotifications'
 616         stateChangeDefinition:
 617           $ref: 'comDefs.yaml#/components/schemas/AttributeValueChangeSet'
 618         monitoredAttributes:
 619           $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
 620         proposedRepairActions:
 621           type: string
 622         additionalText:
 623           type: string
 624         additionalInformation:
 625           $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
 626
 627         rootCauseIndicator:
 628           type: boolean
 629
 630         ackTime:
 631           $ref: 'comDefs.yaml#/components/schemas/DateTime'
 632         ackUserId:
 633           type: string
 634         ackSystemId:
 635           type: string
 636         ackState:
 637           $ref: '#/components/schemas/AckState'
 638
 639         clearUserId:
 640           type: string
 641         clearSystemId:
 642           type: string
 643         serviceUser:
 644           type: string
 645         serviceProvider:
 646           type: string
 647         securityAlarmDetector:
 648           type: string
 649
 650     #---- Definition of alarm notifications --------------------------------------------#
 651
 652     AlarmNotificationType:
 653       type: string
 654       enum:
 655         - notifyNewAlarm
 656         - notifyChangedAlarm
 657         - notifyChangedAlarmGeneral
 658         - notifyAckStateChanged
 659         - notifyCorrelatedNotificationChanged
 660         - notifyComments
 661         - notifyClearedAlarm
 662         - notifyAlarmListRebuiltAlarm
 663         - notifyPotentialFaultyAlarmList
 664     AlarmListAlignmentRequirement:
 665       type: string
 666       enum:
 667         - ALIGNMENT_REQUIRED
 668         - ALIGNMENT_NOT_REQUIRED
 669
 670     NotifyNewAlarm:
 671       allOf:
 672         - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
 673         - type: object
 674           required:
 675             - alarmId
 676             - alarmType
 677             - probableCause
 678             - perceivedSeverity
 679           properties:
 680             alarmId:
 681               $ref: '#/components/schemas/AlarmId'
 682             alarmType:
 683               $ref: '#/components/schemas/AlarmType'
 684             probableCause:
 685               $ref: '#/components/schemas/ProbableCause'
 686             specificProblem:
 687               $ref: '#/components/schemas/SpecificProblem'
 688             perceivedSeverity:
 689               $ref: '#/components/schemas/PerceivedSeverity'
 690             backedUpStatus:
 691               type: boolean
 692             backUpObject:
 693               $ref: 'comDefs.yaml#/components/schemas/Dn'
 694             trendIndication:
 695               $ref: '#/components/schemas/TrendIndication'
 696             thresholdInfo:
 697               $ref: '#/components/schemas/ThresholdInfo'
 698             correlatedNotifications:
 699               $ref: '#/components/schemas/CorrelatedNotifications'
 700             stateChangeDefinition:
 701               $ref: 'comDefs.yaml#/components/schemas/AttributeValueChangeSet'
 702             monitoredAttributes:
 703               $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
 704             proposedRepairActions:
 705               type: string
 706             additionalText:
 707               type: string
 708             additionalInformation:
 709               $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
 710             rootCauseIndicator:
 711               type: boolean
 712     NotifyNewSecAlarm:
 713       allOf:
 714         - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
 715         - type: object
 716           required:
 717             - alarmId
 718             - alarmType
 719             - probableCause
 720             - perceivedSeverity
 721             - serviceUser
 722             - serviceProvider
 723             - securityAlarmDetector
 724           properties:
 725             alarmId:
 726               $ref: '#/components/schemas/AlarmId'
 727             alarmType:
 728               $ref: '#/components/schemas/AlarmType'
 729             probableCause:
 730               $ref: '#/components/schemas/ProbableCause'
 731             perceivedSeverity:
 732               $ref: '#/components/schemas/PerceivedSeverity'
 733             correlatedNotifications:
 734               $ref: '#/components/schemas/CorrelatedNotifications'
 735             additionalText:
 736               type: string
 737             additionalInformation:
 738               $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
 739             rootCauseIndicator:
 740               type: boolean
 741             serviceUser:
 742               type: string
 743             serviceProvider:
 744               type: string
 745             securityAlarmDetector:
 746               type: string
 747     NotifyClearedAlarm:
 748       allOf:
 749         - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
 750         - type: object
 751           required:
 752             - alarmId
 753             - alarmType
 754             - probableCause
 755             - perceivedSeverity
 756           properties:
 757             alarmId:
 758               $ref: '#/components/schemas/AlarmId'
 759             alarmType:
 760               $ref: '#/components/schemas/AlarmType'
 761             probableCause:
 762               $ref: '#/components/schemas/ProbableCause'
 763             perceivedSeverity:
 764               $ref: '#/components/schemas/PerceivedSeverity'
 765             correlatedNotifications:
 766               $ref: '#/components/schemas/CorrelatedNotifications'
 767             clearUserId:
 768               type: string
 769             clearSystemId:
 770               type: string
 771     NotifyChangedAlarm:
 772       allOf:
 773         - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
 774         - type: object
 775           required:
 776             - alarmId
 777             - alarmType
 778             - probableCause
 779             - perceivedSeverity
 780           properties:
 781             alarmId:
 782               $ref: '#/components/schemas/AlarmId'
 783             alarmType:
 784               $ref: '#/components/schemas/AlarmType'
 785             probableCause:
 786               $ref: '#/components/schemas/ProbableCause'
 787             perceivedSeverity:
 788               $ref: '#/components/schemas/PerceivedSeverity'
 789     NotifyChangedAlarmGeneral:
 790       allOf:
 791         - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
 792         - type: object
 793           required:
 794             - alarmId
 795             - alarmType
 796             - probableCause
 797             - perceivedSeverity
 798             - changedAlarmAttributes
 799           properties:
 800             alarmId:
 801               $ref: '#/components/schemas/AlarmId'
 802             alarmType:
 803               $ref: '#/components/schemas/AlarmType'
 804             probableCause:
 805               $ref: '#/components/schemas/ProbableCause'
 806             specificProblem:
 807               $ref: '#/components/schemas/SpecificProblem'
 808             perceivedSeverity:
 809               $ref: '#/components/schemas/PerceivedSeverity'
 810             correlatedNotifications:
 811               $ref: '#/components/schemas/CorrelatedNotifications'
 812             backedUpStatus:
 813               type: boolean
 814             backUpObject:
 815               $ref: 'comDefs.yaml#/components/schemas/Dn'
 816             trendIndication:
 817               $ref: '#/components/schemas/TrendIndication'
 818             thresholdInfo:
 819               $ref: '#/components/schemas/ThresholdInfo'
 820             stateChangeDefinition:
 821               $ref: 'comDefs.yaml#/components/schemas/AttributeValueChangeSet'
 822             monitoredAttributes:
 823               $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
 824             proposedRepairActions:
 825               type: string
 826             additionalText:
 827               type: string
 828             additionalInformation:
 829               $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
 830             rootCauseIndicator:
 831               type: boolean
 832             changedAlarmAttributes:
 833               $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
 834     NotifyChangedSecAlarmGeneral:
 835       allOf:
 836         - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
 837         - type: object
 838           required:
 839             - alarmId
 840             - alarmType
 841             - probableCause
 842             - perceivedSeverity
 843             - serviceUser
 844             - serviceProvider
 845             - securityAlarmDetector
 846             - changedAlarmAttributes
 847           properties:
 848             alarmId:
 849               $ref: '#/components/schemas/AlarmId'
 850             alarmType:
 851               $ref: '#/components/schemas/AlarmType'
 852             probableCause:
 853               $ref: '#/components/schemas/ProbableCause'
 854             perceivedSeverity:
 855               $ref: '#/components/schemas/PerceivedSeverity'
 856             correlatedNotifications:
 857               $ref: '#/components/schemas/CorrelatedNotifications'
 858             additionalText:
 859               type: string
 860             additionalInformation:
 861               $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
 862             rootCauseIndicator:
 863               type: boolean
 864             serviceUser:
 865               type: string
 866             serviceProvider:
 867               type: string
 868             securityAlarmDetector:
 869               type: string
 870             changedAlarmAttributes:
 871               $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
 872     NotifyCorrelatedNotificationChanged:
 873       allOf:
 874         - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
 875         - type: object
 876           required:
 877             - alarmId
 878             - correlatedNotifications
 879           properties:
 880             alarmId:
 881               $ref: '#/components/schemas/AlarmId'
 882             correlatedNotifications:
 883               $ref: '#/components/schemas/CorrelatedNotifications'
 884             rootCauseIndicator:
 885               type: boolean
 886     NotifyAckStateChanged:
 887       allOf:
 888         - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
 889         - type: object
 890           required:
 891             - alarmId
 892             - alarmType
 893             - probableCause
 894             - perceivedSeverity
 895             - ackState
 896             - ackUserId
 897           properties:
 898             alarmId:
 899               $ref: '#/components/schemas/AlarmId'
 900             alarmType:
 901               $ref: '#/components/schemas/AlarmType'
 902             probableCause:
 903               $ref: '#/components/schemas/ProbableCause'
 904             perceivedSeverity:
 905               $ref: '#/components/schemas/PerceivedSeverity'
 906             ackState:
 907               $ref: '#/components/schemas/AckState'
 908             ackUserId:
 909               type: string
 910             ackSystemId:
 911               type: string
 912     NotifyComments:
 913       allOf:
 914         - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
 915         - type: object
 916           required:
 917             - alarmId
 918             - alarmType
 919             - probableCause
 920             - perceivedSeverity
 921             - comments
 922           properties:
 923             alarmId:
 924               $ref: '#/components/schemas/AlarmId'
 925             alarmType:
 926               $ref: '#/components/schemas/AlarmType'
 927             probableCause:
 928               $ref: '#/components/schemas/ProbableCause'
 929             perceivedSeverity:
 930               $ref: '#/components/schemas/PerceivedSeverity'
 931             comments:
 932               $ref: '#/components/schemas/Comments'
 933     NotifyPotentialFaultyAlarmList:
 934       allOf:
 935         - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
 936         - type: object
 937           required:
 938             - reason
 939           properties:
 940             reason:
 941               type: string
 942     NotifyAlarmListRebuilt:
 943       allOf:
 944         - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
 945         - type: object
 946           required:
 947             - reason
 948           properties:
 949             reason:
 950               type: string
 951             alarmListAlignmentRequirement:
 952               $ref: '#/components/schemas/AlarmListAlignmentRequirement'
 953
 954     #---- Definition of query parameters -----------------------------------------------#
 955
 956     AlarmAckState:
 957       type: string
 958       enum:
 959         - ALL_ALARMS
 960         - ALL_ACTIVE_ALARMS
 961         - ALL_ACTIVE_AND_ACKNOWLEDGED_ALARMS
 962         - ALL_ACTIVE_AND_UNACKNOWLEDGED_ALARMS
 963         - ALL_CLEARED_AND_UNACKNOWLEDGED_ALARMS
 964         - ALL_UNACKNOWLEDGED_ALARMS
 965
 966     #---- Definition of patch documents ------------------------------------------------#
 967
 968     MergePatchAcknowledgeAlarm:
 969       description: >-
 970         Patch document acknowledging or unacknowledging a single alarm. For
 971         acknowleding an alarm the value of ackState is ACKNOWLEDGED, for unacknowleding
 972         an alarm the value of ackState is UNACKNOWLEDGED.
 973       type: object
 974       required:
 975         - ackUserId
 976         - ackState
 977       properties:
 978         ackUserId:
 979           type: string
 980         ackSystemId:
 981           type: string
 982         ackState:
 983           $ref: '#/components/schemas/AckState'
 984     MergePatchClearAlarm:
 985       description: Patch document for clearing a single alarm
 986       type: object
 987       required:
 988         - clearUserId
 989         - perceivedSeverity
 990       properties:
 991         clearUserId:
 992           type: string
 993         clearSystemId:
 994           type: string
 995         perceivedSeverity:
 996           type: string
 997           enum:
 998             - CLEARED
 999
1000     #---- Definition of method responses -----------------------------------------------#
1001
1002     FailedAlarm:
1003       type: object
1004       required:
1005         - alarmId
1006         - failureReason
1007       properties:
1008         alarmId:
1009           $ref: '#/components/schemas/AlarmId'
1010         failureReason:
1011           type: string
1012
1013     #---- Definition of resources ------------------------------------------------------#
1014
1015     AlarmCount:
1016       type: object
1017       required:
1018         - criticalCount
1019         - majorCount
1020         - minorCount
1021         - warningCount
1022         - indeterminateCount
1023         - clearedCount
1024       properties:
1025         criticalCount:
1026           type: integer
1027         majorCount:
1028           type: integer
1029         minorCount:
1030           type: integer
1031         warningCount:
1032           type: integer
1033         indeterminateCount:
1034           type: integer
1035         clearedCount:
1036           type: integer
1037     Comment:
1038       type: object
1039       properties:
1040         commentTime:
1041           $ref: 'comDefs.yaml#/components/schemas/DateTime'
1042         commentUserId:
1043           type: string
1044         commentSystemId:
1045           type: string
1046         commentText:
1047           type: string
1048     Comments:
1049       description: >-
1050         Collection of comments. The comment identifiers are allocated by the
1051         MnS producer and used as key in the map.
1052       type: object
1053       additionalProperties:
1054         $ref: '#/components/schemas/Comment'
1055     Subscription:
1056       type: object
1057       properties:
1058         consumerReference:
1059           $ref: 'comDefs1.yaml#/components/schemas/Uri'
1060         timeTick:
1061           $ref: 'comDefs1.yaml#/components/schemas/Long'
1062         filter:
1063           $ref: 'comDefs1.yaml#/components/schemas/Filter'