[DCAEGEN2] Add new OpenAPI schemas configmap

[oom.git] / kubernetes / dcaegen2-services / resources / external / schemas / sa91-rel16 / faultMnS.yaml

diff --git a/kubernetes/dcaegen2/resources/external/schema/rel16/faultMnS.yaml b/kubernetes/dcaegen2-services/resources/external/schemas/sa91-rel16/faultMnS.yaml
similarity index 82%
rename from kubernetes/dcaegen2/resources/external/schema/rel16/faultMnS.yaml
rename to kubernetes/dcaegen2-services/resources/external/schemas/sa91-rel16/faultMnS.yaml
index 499123b..7ccf280 100644 (file)
--- a/kubernetes/dcaegen2/resources/external/schema/rel16/faultMnS.yaml
+++ b/kubernetes/dcaegen2-services/resources/external/schemas/sa91-rel16/faultMnS.yaml
@@ -1,22 +1,22 @@
 openapi: 3.0.1
 info:
   title: Fault Supervision MnS
-  version: 16.4.0
+  version: 16.6.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
+  description: 3GPP TS 28.532; Generic management services
   url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/
 servers:
-  - url: '{MnSRoot}/FaultSupervisionMnS/{version}'
+  - url: '{MnSRoot}/FaultSupervisionMnS/{MnSversion}'
     variables:
       MnSRoot:
         description: See subclause 4.4.3 of TS 32.158
         default: http://example.com/3GPPManagement
-      version:
-        description: Versi      on number of the OpenAPI definition
+      MnSversion:
+        description: Version number of the OpenAPI definition
         default: XXX
 paths:
   /alarms:
@@ -35,12 +35,12 @@ paths:
           in: query
           required: false
           schema:
-            $ref: '#/components/schemas/Dn'
+            $ref: 'comDefs.yaml#/components/schemas/Dn'
         - name: filter
           in: query
           required: false
           schema:
-            $ref: '#/components/schemas/Filter'
+            $ref: 'comDefs.yaml#/components/schemas/Filter'
       responses:
         '200':
           description: >-
@@ -57,7 +57,7 @@ paths:
                       - type: object
                         properties:
                           lastNotificationHeader:
-                            $ref: '#/components/schemas/NotificationHeader'
+                            $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
                       - $ref: '#/components/schemas/AlarmRecord'
                       - type: object
                         properties:
@@ -68,7 +68,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/ErrorResponse'
+                $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
     patch:
       summary: 'Clear, acknowledge or unacknowledge multiple alarms'
       description: >-
@@ -130,7 +130,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/ErrorResponse'
+                $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
   /alarms/{alarmId}:
     patch:
       summary: 'Clear, acknowledge or unacknowledge a single alarm'
@@ -163,7 +163,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/ErrorResponse'
+                $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
   /alarms/{alarmId}/comments:
     post:
       summary: Add a comment to a single alarm
@@ -203,7 +203,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/ErrorResponse'
+                $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
 
   /subscriptions:
     post:
@@ -238,7 +238,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/ErrorResponse'
+                $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
       callbacks:
         notifyNewAlarm:
           '{request.body#/consumerReference}':
@@ -262,7 +262,7 @@ paths:
                   content:
                     application/json:
                       schema:
-                        $ref: '#/components/schemas/ErrorResponse'
+                        $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
         notifyClearedAlarm:
           '{request.body#/consumerReference}':
             post:
@@ -283,7 +283,7 @@ paths:
                   content:
                     application/json:
                       schema:
-                        $ref: '#/components/schemas/ErrorResponse'
+                        $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
         notifyChangedAlarm:
           '{request.body#/consumerReference}':
             post:
@@ -304,7 +304,7 @@ paths:
                   content:
                     application/json:
                       schema:
-                        $ref: '#/components/schemas/ErrorResponse'
+                        $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
         notifyChangedAlarmGeneral:
           '{request.body#/consumerReference}':
             post:
@@ -327,7 +327,7 @@ paths:
                   content:
                     application/json:
                       schema:
-                        $ref: '#/components/schemas/ErrorResponse'
+                        $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
         notifyCorrelatedNotificationChanged:
           '{request.body#/consumerReference}':
             post:
@@ -348,7 +348,7 @@ paths:
                   content:
                     application/json:
                       schema:
-                        $ref: '#/components/schemas/ErrorResponse'
+                        $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
         notifyAckStateChanged:
           '{request.body#/consumerReference}':
             post:
@@ -369,7 +369,7 @@ paths:
                   content:
                     application/json:
                       schema:
-                        $ref: '#/components/schemas/ErrorResponse'
+                        $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
         notifyComments:
           '{request.body#/consumerReference}':
             post:
@@ -390,7 +390,7 @@ paths:
                   content:
                     application/json:
                       schema:
-                        $ref: '#/components/schemas/ErrorResponse'
+                        $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
         notifyPotentialFaultyAlarmList:
           '{request.body#/consumerReference}':
             post:
@@ -411,7 +411,7 @@ paths:
                   content:
                     application/json:
                       schema:
-                        $ref: '#/components/schemas/ErrorResponse'
+                        $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
         notifyAlarmListRebuilt:
           '{request.body#/consumerReference}':
             post:
@@ -432,7 +432,7 @@ paths:
                   content:
                     application/json:
                       schema:
-                        $ref: '#/components/schemas/ErrorResponse'
+                        $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
   /subscriptions/{subscriptionId}:
     delete:
       summary: Delete a subscription
@@ -458,91 +458,10 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/ErrorResponse'
+                $ref: 'comDefs.yaml#/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 ----------------------------------------------------#
  
@@ -608,46 +527,47 @@ components:
         high:
           oneOf:
             - type: integer
-            - $ref: '#/components/schemas/Float'
+            - $ref: 'comDefs.yaml#/components/schemas/Float'
         low:
-          $ref: '#/components/schemas/Float'
+          $ref: 'comDefs.yaml#/components/schemas/Float'
     ThresholdLevelInd:
-      type: object
-      required:
-        - up
-      properties:
-        up:
-          $ref: '#/components/schemas/ThresholdHysteresis'
-        low:
-          $ref: '#/components/schemas/ThresholdHysteresis'
+      oneOf:
+        - type: object
+          properties:
+            up:
+              $ref: '#/components/schemas/ThresholdHysteresis'
+        - type: object
+          properties:
+            down:
+              $ref: '#/components/schemas/ThresholdHysteresis'
     ThresholdInfo:
       type: object
-      required:
-        - observedMeasurement
-        - observedValue
       properties:
         observedMeasurement:
           type: string
         observedValue:
           oneOf:
             - type: integer
-            - $ref: '#/components/schemas/Float'
-        thresholdLevelInd:
+            - $ref: 'comDefs.yaml#/components/schemas/Float'
+        thresholdLevel:
           $ref: '#/components/schemas/ThresholdLevelInd'
         armTime:
-          $ref: '#/components/schemas/DateTime'
+          $ref: 'comDefs.yaml#/components/schemas/DateTime'
+      required:
+        - observedMeasurement
+        - observedValue
     CorrelatedNotification:
       type: object
-      required:
-        - source
-        - notificationId
       properties:
         sourceObjectInstance:
-          $ref: '#/components/schemas/Dn'
+          $ref: 'comDefs.yaml#/components/schemas/Dn'
         notificationIds:
           type: array
           items:
-            $ref: '#/components/schemas/NotificationId'
+            $ref: 'comDefs.yaml#/components/schemas/NotificationId'
+      required:
+        - sourceObjectInstance
+        - notificationIds
     CorrelatedNotifications:
       type: array
       items:
@@ -667,15 +587,15 @@ components:
         # alarmId:
         #  $ref: '#/components/schemas/AlarmId'
         objectInstance:
-          $ref: '#/components/schemas/Dn'
+          $ref: 'comDefs.yaml#/components/schemas/Dn'
         notificationId:
-          $ref: '#/components/schemas/NotificationId'
+          $ref: 'comDefs.yaml#/components/schemas/NotificationId'
         alarmRaisedTime:
-          $ref: '#/components/schemas/DateTime'
+          $ref: 'comDefs.yaml#/components/schemas/DateTime'
         alarmChangedTime:
-          $ref: '#/components/schemas/DateTime'
+          $ref: 'comDefs.yaml#/components/schemas/DateTime'
         alarmClearedTime:
-          $ref: '#/components/schemas/DateTime'
+          $ref: 'comDefs.yaml#/components/schemas/DateTime'
         alarmType:
           $ref: '#/components/schemas/AlarmType'
         probableCause:
@@ -687,7 +607,7 @@ components:
         backedUpStatus:
           type: boolean
         backUpObject:
-          $ref: '#/components/schemas/Dn'
+          $ref: 'comDefs.yaml#/components/schemas/Dn'
         trendIndication:
           $ref: '#/components/schemas/TrendIndication'
         thresholdinfo:
@@ -695,21 +615,21 @@ components:
         correlatedNotifications:
           $ref: '#/components/schemas/CorrelatedNotifications'
         stateChangeDefinition:
-          $ref: '#/components/schemas/AttributeValueChangeSet'
+          $ref: 'comDefs.yaml#/components/schemas/AttributeValueChangeSet'
         monitoredAttributes:
-          $ref: '#/components/schemas/AttributeNameValuePairSet'
+          $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
         proposedRepairActions:
           type: string
         additionalText:
           type: string
         additionalInformation:
-          $ref: '#/components/schemas/AttributeNameValuePairSet'
+          $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
 
         rootCauseIndicator:
           type: boolean
 
         ackTime:
-          $ref: '#/components/schemas/DateTime'
+          $ref: 'comDefs.yaml#/components/schemas/DateTime'
         ackUserId:
           type: string
         ackSystemId:
@@ -750,7 +670,7 @@ components:
 
     NotifyNewAlarm:
       allOf:
-        - $ref: '#/components/schemas/NotificationHeader'
+        - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
         - type: object
           required:
             - alarmId
@@ -771,7 +691,7 @@ components:
             backedUpStatus:
               type: boolean
             backUpObject:
-              $ref: '#/components/schemas/Dn'
+              $ref: 'comDefs.yaml#/components/schemas/Dn'
             trendIndication:
               $ref: '#/components/schemas/TrendIndication'
             thresholdInfo:
@@ -779,20 +699,20 @@ components:
             correlatedNotifications:
               $ref: '#/components/schemas/CorrelatedNotifications'
             stateChangeDefinition:
-              $ref: '#/components/schemas/AttributeValueChangeSet'
+              $ref: 'comDefs.yaml#/components/schemas/AttributeValueChangeSet'
             monitoredAttributes:
-              $ref: '#/components/schemas/AttributeNameValuePairSet'
+              $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
             proposedRepairActions:
               type: string
             additionalText:
               type: string
             additionalInformation:
-              $ref: '#/components/schemas/AttributeNameValuePairSet'
+              $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
             rootCauseIndicator:
               type: boolean
     NotifyNewSecAlarm:
       allOf:
-        - $ref: '#/components/schemas/NotificationHeader'
+        - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
         - type: object
           required:
             - alarmId
@@ -816,7 +736,7 @@ components:
             additionalText:
               type: string
             additionalInformation:
-              $ref: '#/components/schemas/AttributeNameValuePairSet'
+              $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
             rootCauseIndicator:
               type: boolean
             serviceUser:
@@ -827,7 +747,7 @@ components:
               type: string
     NotifyClearedAlarm:
       allOf:
-        - $ref: '#/components/schemas/NotificationHeader'
+        - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
         - type: object
           required:
             - alarmId
@@ -851,7 +771,7 @@ components:
               type: string
     NotifyChangedAlarm:
       allOf:
-        - $ref: '#/components/schemas/NotificationHeader'
+        - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
         - type: object
           required:
             - alarmId
@@ -869,14 +789,11 @@ components:
               $ref: '#/components/schemas/PerceivedSeverity'
     NotifyChangedAlarmGeneral:
       allOf:
-        - $ref: '#/components/schemas/NotificationHeader'
+        - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
         - type: object
           required:
             - alarmId
             - alarmType
-            - probableCause
-            - perceivedSeverity
-            - changedAlarmAttributes
           properties:
             alarmId:
               $ref: '#/components/schemas/AlarmId'
@@ -893,38 +810,35 @@ components:
             backedUpStatus:
               type: boolean
             backUpObject:
-              $ref: '#/components/schemas/Dn'
+              $ref: 'comDefs.yaml#/components/schemas/Dn'
             trendIndication:
               $ref: '#/components/schemas/TrendIndication'
             thresholdInfo:
               $ref: '#/components/schemas/ThresholdInfo'
             stateChangeDefinition:
-              $ref: '#/components/schemas/AttributeValueChangeSet'
+              $ref: 'comDefs.yaml#/components/schemas/AttributeValueChangeSet'
             monitoredAttributes:
-              $ref: '#/components/schemas/AttributeNameValuePairSet'
+              $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
             proposedRepairActions:
               type: string
             additionalText:
               type: string
             additionalInformation:
-              $ref: '#/components/schemas/AttributeNameValuePairSet'
+              $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
             rootCauseIndicator:
               type: boolean
             changedAlarmAttributes:
-              $ref: '#/components/schemas/AttributeNameValuePairSet'
+              $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
     NotifyChangedSecAlarmGeneral:
       allOf:
-        - $ref: '#/components/schemas/NotificationHeader'
+        - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
         - type: object
           required:
             - alarmId
             - alarmType
-            - probableCause
-            - perceivedSeverity
             - serviceUser
             - serviceProvider
             - securityAlarmDetector
-            - changedAlarmAttributes
           properties:
             alarmId:
               $ref: '#/components/schemas/AlarmId'
@@ -939,7 +853,7 @@ components:
             additionalText:
               type: string
             additionalInformation:
-              $ref: '#/components/schemas/AttributeNameValuePairSet'
+              $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
             rootCauseIndicator:
               type: boolean
             serviceUser:
@@ -949,10 +863,10 @@ components:
             securityAlarmDetector:
               type: string
             changedAlarmAttributes:
-              $ref: '#/components/schemas/AttributeNameValuePairSet'
+              $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
     NotifyCorrelatedNotificationChanged:
       allOf:
-        - $ref: '#/components/schemas/NotificationHeader'
+        - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
         - type: object
           required:
             - alarmId
@@ -966,7 +880,7 @@ components:
               type: boolean
     NotifyAckStateChanged:
       allOf:
-        - $ref: '#/components/schemas/NotificationHeader'
+        - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
         - type: object
           required:
             - alarmId
@@ -992,7 +906,7 @@ components:
               type: string
     NotifyComments:
       allOf:
-        - $ref: '#/components/schemas/NotificationHeader'
+        - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
         - type: object
           required:
             - alarmId
@@ -1013,7 +927,7 @@ components:
               $ref: '#/components/schemas/Comments'
     NotifyPotentialFaultyAlarmList:
       allOf:
-        - $ref: '#/components/schemas/NotificationHeader'
+        - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
         - type: object
           required:
             - reason
@@ -1022,7 +936,7 @@ components:
               type: string
     NotifyAlarmListRebuilt:
       allOf:
-        - $ref: '#/components/schemas/NotificationHeader'
+        - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
         - type: object
           required:
             - reason
@@ -1119,7 +1033,7 @@ components:
       type: object
       properties:
         commentTime:
-          $ref: '#/components/schemas/DateTime'
+          $ref: 'comDefs.yaml#/components/schemas/DateTime'
         commentUserId:
           type: string
         commentSystemId:
@@ -1137,8 +1051,8 @@ components:
       type: object
       properties:
         consumerReference:
-          $ref: '#/components/schemas/Uri'
+          $ref: 'comDefs.yaml#/components/schemas/Uri'
         timeTick:
-          $ref: '#/components/schemas/Long'
+          type: integer
         filter:
-          $ref: '#/components/schemas/Filter'
+          $ref: 'comDefs.yaml#/components/schemas/Filter'