[POLICY-22] Reorganizing drools-apps
[policy/drools-applications.git] / controlloop / common / model-impl / events / src / main / resources / definitions.yaml
@@ -1,23 +1,34 @@
-###
-# ============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=========================================================
-###
-
+AAI:
+  type: object
+  properties:
+    AICVServerSelfLink:
+      type: string
+    VNF_NAME:
+      type: string
+    AICVMID:
+      type: string
+    AICTenantID:
+      type: string
+    LOC_ID:
+      type: string
+    in_maint:
+      type: boolean
+    AICIdentity:
+      type: string
+    Prov_status:
+      type: string
+    OAM_IPV4:
+      type: string
+    is_closed_loop_disabled:
+      type: boolean
+    VM_NAME:
+      type: string
+    OAM_IPV6:
+      type: string
+  required:
+    - AICVServerSelfLink
+    - AICIdentity
+    - is_closed_loop_disabled
 ControlLoop:
   type: object
   description: Common fields for control loop events and notifications
@@ -25,10 +36,20 @@ ControlLoop:
     closedLoopControlName:
       type: string
       description: A UNIQUE string identifying the Closed Loop ID this event is for. There are no semantics behind this string.
+    serviceInstance:
+      $ref: '../../../com.att.ecomp.policy.asdc/src/main/resources/definitions.yaml#/serviceInstance'
+    resourceInstance:
+      $ref: '../../../com.att.ecomp.policy.asdc/src/main/resources/definitions.yaml#/resourceInstance'
     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}/
+    triggerID:
+      type: string
+      description: ID that maps back to Highland Park. Concatenation between eventID and firstEPOCH.
+    triggerSourceName:
+      type: string
+      description: pulled from eventSourceName of trigger H.P. alarm. The contents of this field should also be contained in the AAI Json sub-tag (see below).
     closedLoopAlarmStart:
       type: string
       description: firstEpoch. UTC Timestamp when this event was detected by DCAE. Conform to ECOMP Logging requirements.
@@ -42,23 +63,20 @@ ControlLoop:
       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.
+      $ref: '#/AAI'
     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
+    - triggerID
+    - triggerSourceName
     - closedLoopAlarmStart
     - closedLoopEventClient
     - target
@@ -73,7 +91,7 @@ Event:
     - properties:
       closedLoopEventStatus:
         type: string
-        description: The status for the event within Open DCAE. A value of â\80\9cONSETâ\80? indicates the event has been encountered. â\80\9cABATEDâ\80? indicates the event has been abated.
+        description: The status for the event within Open DCAE. A value of â\80\9cONSETâ\80\9d indicates the event has been encountered. â\80\9cABATEDâ\80\9d indicates the event has been abated.
         valid_values:
           - ONSET
           - ABATEMENT