Merge "Move RefreshConfigTask under tasks"
[nonrtric.git] / sdnc-a1-controller / northbound / nonrt-ric-api / model / src / main / yang / NONRT-RIC-API.yang
index b6a2869..986e201 100644 (file)
@@ -1,3 +1,22 @@
+//-\r
+// ============LICENSE_START=======================================================\r
+//  Copyright (C) 2019 Nordix Foundation.\r
+// ================================================================================\r
+// Licensed under the Apache License, Version 2.0 (the "License");\r
+// you may not use this file except in compliance with the License.\r
+// You may obtain a copy of the License at\r
+//\r
+//      http://www.apache.org/licenses/LICENSE-2.0\r
+//\r
+// Unless required by applicable law or agreed to in writing, software\r
+// distributed under the License is distributed on an "AS IS" BASIS,\r
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+// See the License for the specific language governing permissions and\r
+// limitations under the License.\r
+//\r
+// SPDX-License-Identifier: Apache-2.0\r
+// ============LICENSE_END=========================================================\r
+//\r
 module A1-ADAPTER-API {\r
 \r
     namespace "org:onap:sdnc:northbound:a1-adapter";\r
@@ -10,18 +29,21 @@ module A1-ADAPTER-API {
 \r
     revision "2019-10-02" {\r
         description\r
-        "A1 adapter for Frankfurt";\r
+        "A1 adapter";\r
     }\r
 \r
-///Flattend interface using RPC\r
+    //Flattend interface using RPC\r
 \r
-    //Get a comma separated list of near-rt rics, e.g. domain-name1:port1,domainname2:port2\r
-    //Each item in the returned list will be regarded as one near-rt-ric-id.\r
+    //Get an array of near-rt-ric IDs,\r
+    //Each item in the returned array will be regarded as one near-rt-ric-id.\r
     rpc getNearRT-RICs {\r
         output {\r
             leaf-list near-rt-ric-id-list {\r
                 type string;\r
             }\r
+            leaf code {\r
+                type string;\r
+            }\r
         }\r
     }\r
 \r
@@ -37,11 +59,14 @@ module A1-ADAPTER-API {
             leaf health-status {\r
                 type boolean;\r
             }\r
-        }   \r
+            leaf code {\r
+                type string;\r
+            }\r
+        }\r
     }\r
 \r
-    //Get a comma separated list of integer policy type ids\r
-    //Each item in the returned list will be regarded as one policy-type-id.\r
+    //Get an array of integer policy type ids\r
+    //Each item in the returned array will be regarded as one policy-type-id.\r
     rpc getPolicyTypes {\r
         input {\r
             leaf near-rt-ric-id {\r
@@ -53,6 +78,9 @@ module A1-ADAPTER-API {
             leaf-list policy-type-id-list {\r
                 type uint32;\r
             }\r
+            leaf code {\r
+                type string;\r
+            }\r
         }\r
     }\r
 \r
@@ -76,9 +104,6 @@ module A1-ADAPTER-API {
             }\r
         }\r
        output {\r
-            leaf status {\r
-                type string;\r
-            }\r
             leaf code {\r
                 type string;\r
             }\r
@@ -105,6 +130,9 @@ module A1-ADAPTER-API {
             leaf policy-type {\r
                 type string;\r
             }\r
+            leaf code {\r
+                type string;\r
+            }\r
         }\r
     }\r
 \r
@@ -118,10 +146,15 @@ module A1-ADAPTER-API {
                 type uint32;\r
             }\r
         }\r
+        output {\r
+            leaf code {\r
+                type string;\r
+            }\r
+        }\r
     }\r
 \r
-    //Get a comma separeated list of string policy instance ids\r
-    //Each item in the returned list will be regarded as one policy-instance-id.\r
+    //Get an array of string policy instance ids\r
+    //Each item in the returned array will be regarded as one policy-instance-id.\r
     rpc getPolicyInstances {\r
         input {\r
             leaf near-rt-ric-id {\r
@@ -136,6 +169,9 @@ module A1-ADAPTER-API {
             leaf-list policy-instance-id-list {\r
                 type string;\r
             }\r
+            leaf code {\r
+                type string;\r
+            }\r
         }\r
     }\r
 \r
@@ -155,8 +191,13 @@ module A1-ADAPTER-API {
                 type string;\r
             }\r
         }\r
+        output {\r
+            leaf code {\r
+                type string;\r
+            }\r
+        }\r
     }\r
-    \r
+\r
     ///Get a policy instance\r
     rpc getPolicyInstance {\r
         input {\r
@@ -174,9 +215,12 @@ module A1-ADAPTER-API {
             leaf policy-instance {\r
                 type string;\r
             }\r
+            leaf code {\r
+                type string;\r
+            }\r
         }\r
     }\r
-    \r
+\r
     //Delete a policy instance\r
     rpc deletePolicyInstance {\r
         input {\r
@@ -190,6 +234,11 @@ module A1-ADAPTER-API {
                 type string;\r
             }\r
         }\r
+        output {\r
+            leaf code {\r
+                type string;\r
+            }\r
+        }\r
     }\r
 \r
     //Get the status for a policy instance\r
@@ -209,6 +258,9 @@ module A1-ADAPTER-API {
             leaf status {\r
                 type string;\r
             }\r
+            leaf code {\r
+                type string;\r
+            }\r
         }\r
     }\r
 }
\ No newline at end of file