###
# ============LICENSE_START=======================================================
# controlloop
# ================================================================================
# Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
# ================================================================================
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# 
#      http://www.apache.org/licenses/LICENSE-2.0
# 
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ============LICENSE_END=========================================================
###

ControlLoop:
  type: object
  description: Common fields for control loop events and notifications
  properties:
    closedLoopControlName:
      type: string
      description: A UNIQUE string identifying the Closed Loop ID this event is for. There are no semantics behind this string.
    requestID:
      type: string
      description: This is required via ECOMP Platform Logging Requirements.
      pattern: /[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}/
    closedLoopAlarmStart:
      type: string
      description: firstEpoch. UTC Timestamp when this event was detected by DCAE. Conform to ECOMP Logging requirements.
    closedLoopAlarmEnd:
      type: string
      description: lastEpoch.  UTC Timestamp when this event was detected as cleared by DCAE. Conform to ECOMP Logging requirements.
    closedLoopEventClient:
      type: string
      description: Open DCAE sub-system that detected the event and published this event message.
    target:
      type: string
      description: The target entity that is being administered. This could be VM_NAME, VNF_NAME, etc. This should map to a field name in the AAI sub-tag shown below.
    AAI:
      type: object
      description: Fields of node.attribute and their values that map to AAI topology.
    from:
      type: string
      description: The ECOMP component generating this message.
    policyScope:
      type: string
      description: The policy scope driving the generation of this message.
    policyName:
      type: string
      description: The policy name driving the generation of this message.
    policyVersion:
      type: string
      description: The policy version driving the generation of this message.
  required:
    - closedLoopControlName
    - requestID
    - closedLoopAlarmStart
    - closedLoopEventClient
    - target
    - AAI
    - from
    - policyScope
    - policyName
    - policyVersion
Event:
  allOf:
    - $ref: '#/ControlLoop'
    - properties:
      closedLoopEventStatus:
        type: string
        description: The status for the event within Open DCAE. A value of “ONSET� indicates the event has been encountered. “ABATED� indicates the event has been abated.
        valid_values:
          - ONSET
          - ABATEMENT
    - required:
      - closedLoopEventStatus
Notification:
    - $ref: '#/ControlLoop'
    - properties:
      notification:
        type: string
      notificationTime:
        type: string
      message:
        type: string
      OPS_CL_timer:
        type: int
    - required:
      - notification
      - notificationTime
      - OPS_CL_timer