Commit 2bf16c1d authored by ruiyue's avatar ruiyue
Browse files

Merge branch 'TS28.111_Rel-19_CR_Implement_readonly_attributes_for_openAPI_SS'... 

Merge branch 'TS28.111_Rel-19_CR_Implement_readonly_attributes_for_openAPI_SS' into 'Integration_Rel19_SA5_157_YAML'

TS28.111_Rel-19_CR0014_TS28.623_CR0436_Implement_readonly_attributes_for_openAPI_SS

See merge request !1365
parents f1dd0319 5a70380f

OpenAPI/TS28111_FaultNrm.yaml

+30 −18
Original line number Diff line number Diff line
@@ -40,6 +40,7 @@ components: 
        - PHYSICAL_VIOLATION

        - SECURITY_SERVICE_OR_MECHANISM_VIOLATION

        - TIME_DOMAIN_VIOLATION

      readOnly: true  

    ProbableCause:

      description: >-

        The value of the probable cause may be a specific standardized string, or any
@@ -58,12 +59,17 @@ components: 
                - PROBABLE_CAUSE_003

                - PROBABLE_CAUSE_004

                - PROBABLE_CAUSE_005

              readOnly: true  

            - type: string

              readOnly: true 

        - type: integer

          readOnly: true 

    SpecificProblem:

      oneOf:

        - type: string

          readOnly: true 

        - type: integer

          readOnly: true 

    PerceivedSeverity:

      type: string

      enum:
@@ -75,6 +81,7 @@ components: 
        - CLEARED  

    TrendIndication:

      type: string

      readOnly: true

      enum:

        - MORE_SEVERE

        - NO_CHANGE
@@ -87,9 +94,9 @@ components: 
        high:

          oneOf:

            - type: integer

            - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Float'

            - $ref: 'TS28623_ComDefs.yaml#/components/schemas/FloatRo'

        low:

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/Float'

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/FloatRo'

    ThresholdLevelInd:

      oneOf:

        - type: object
@@ -105,12 +112,14 @@ components: 
      properties:

        observedMeasurement:

          type: string

          readOnly: true

        observedValue:

          type: number

          readOnly: true

        thresholdLevel:

          $ref: '#/components/schemas/ThresholdLevelInd'

        armTime:

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTimeRo'

      required:

        - observedMeasurement

        - observedValue
@@ -118,7 +127,7 @@ components: 
      type: object

      properties:

        sourceObjectInstance:

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'

        notificationIds:

          type: array

          items:
@@ -145,15 +154,15 @@ components: 
        # alarmId:

        #  $ref: '#/components/schemas/AlarmId'

        objectInstance:

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'

        notificationId:

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationId'

        alarmRaisedTime:

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTimeRo'

        alarmChangedTime:

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTimeRo'

        alarmClearedTime:

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTimeRo'

        alarmType:

          $ref: '#/components/schemas/AlarmType'

        probableCause:
@@ -165,7 +174,7 @@ components: 
        backedUpStatus:

          type: boolean

        backUpObject:

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'

        trendIndication:

          $ref: '#/components/schemas/TrendIndication'

        thresholdinfo:
@@ -178,34 +187,36 @@ components: 
          $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet'

        proposedRepairActions:

          type: string

          readOnly: true

        additionalText:

          type: string

          readOnly: true

        additionalInformation:

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet'



        rootCauseIndicator:

          type: boolean



          readOnly: true

        ackTime:

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTimeRo'

        ackUserId:

          type: string

        ackSystemId:

          type: string

        ackState:

          $ref: '#/components/schemas/AckState'



        clearUserId:

          type: string

        clearSystemId:

          type: string

        serviceUser:

          type: string

          readOnly: true

        serviceProvider:

          type: string

          readOnly: true

        securityAlarmDetector:

          type: string



          readOnly: true

    AlarmList-Single:

      allOf:

        - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top'
@@ -220,8 +231,9 @@ components: 
                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/OperationalState'

                numOfAlarmRecords:

                  type: integer

                  readOnly: true

                lastModification:

                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'

                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTimeRo'

                alarmRecords:

                  description: >-

                     This resource represents a map of alarm records.
@@ -230,7 +242,7 @@ components: 
                  additionalProperties:

                    $ref: '#/components/schemas/AlarmRecord'

                unreliableAlarmScope:

                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'

                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'





  #---- Definition of alarm notifications --------------------------------------------#
@@ -539,7 +551,7 @@ components: 
      type: object

      properties:

        commentTime:

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTimeRo'

        commentUserId:

          type: string

        commentSystemId:

OpenAPI/TS28623_ComDefs.yaml

+1 −1
Original line number Diff line number Diff line
@@ -381,9 +381,9 @@ components: 
        Jex advanced profile specified in clause 7.5 of TS 32.161.

    SystemDN:

      type: string



    NotificationId:

      type: integer

      readOnly: true    

    NotificationType:

      oneOf:

        - $ref: 'TS28111_FaultNrm.yaml#/components/schemas/AlarmNotificationTypes'