sdnc-a1-controller/northbound/nonrt-ric-api/model/src/main/yang/NONRT-RIC-API.yang

   1 module A1-ADAPTER-API {\r
   2 \r
   3     namespace "org:onap:sdnc:northbound:a1-adapter";\r
   4 \r
   5     prefix a1-adapter-api;\r
   6 \r
   7     import ietf-inet-types { prefix "inet"; revision-date "2013-07-15"; }\r
   8 \r
   9     import ietf-yang-types { prefix yang; }\r
  10 \r
  11     revision "2019-10-02" {\r
  12         description\r
  13         "A1 adapter for Frankfurt";\r
  14     }\r
  15 \r
  16 ///Flattend interface using RPC\r
  17 \r
  18     //Get a comma separated list of near-rt rics, e.g. domain-name1:port1,domainname2:port2\r
  19     //Each item in the returned list will be regarded as one near-rt-ric-id.\r
  20     rpc getNearRT-RICs {\r
  21         output {\r
  22             leaf-list near-rt-ric-id-list {\r
  23                 type string;\r
  24             }\r
  25         }\r
  26     }\r
  27 \r
  28     //Get health status for a Near-RT-RIC. true - health ok, false - health is not ok.\r
  29     rpc getHealthCheck {\r
  30          input {\r
  31             leaf near-rt-ric-id {\r
  32                 type string;\r
  33             }\r
  34         }\r
  35 \r
  36         output {\r
  37             leaf health-status {\r
  38                 type boolean;\r
  39             }\r
  40         }   \r
  41     }\r
  42 \r
  43     //Get a comma separated list of integer policy type ids\r
  44     //Each item in the returned list will be regarded as one policy-type-id.\r
  45     rpc getPolicyTypes {\r
  46         input {\r
  47             leaf near-rt-ric-id {\r
  48                 type string;\r
  49             }\r
  50         }\r
  51 \r
  52         output {\r
  53             leaf-list policy-type-id-list {\r
  54                 type uint32;\r
  55             }\r
  56         }\r
  57     }\r
  58 \r
  59     //Create a policy type\r
  60     rpc createPolicyType {\r
  61         input {\r
  62             leaf near-rt-ric-id {\r
  63                 type string;\r
  64             }\r
  65             leaf policy-type-id {\r
  66                 type uint32;\r
  67             }\r
  68             leaf description {\r
  69                 type string;\r
  70             }\r
  71             leaf name {\r
  72                 type string;\r
  73             }\r
  74             leaf policy-type {\r
  75                 type string;\r
  76             }\r
  77         }\r
  78        output {\r
  79             leaf status {\r
  80                 type string;\r
  81             }\r
  82             leaf code {\r
  83                 type string;\r
  84             }\r
  85         }\r
  86     }\r
  87 \r
  88     //Get a policy type\r
  89     rpc getPolicyType {\r
  90         input {\r
  91             leaf near-rt-ric-id {\r
  92                 type string;\r
  93             }\r
  94             leaf policy-type-id {\r
  95                 type uint32;\r
  96             }\r
  97         }\r
  98         output {\r
  99             leaf description {\r
 100                 type string;\r
 101             }\r
 102             leaf name {\r
 103                 type string;\r
 104             }\r
 105             leaf policy-type {\r
 106                 type string;\r
 107             }\r
 108         }\r
 109     }\r
 110 \r
 111     //Delete a policy type\r
 112     rpc deletePolicyType {\r
 113         input {\r
 114             leaf near-rt-ric-id {\r
 115                 type string;\r
 116             }\r
 117             leaf policy-type-id {\r
 118                 type uint32;\r
 119             }\r
 120         }\r
 121     }\r
 122 \r
 123     //Get a comma separeated list of string policy instance ids\r
 124     //Each item in the returned list will be regarded as one policy-instance-id.\r
 125     rpc getPolicyInstances {\r
 126         input {\r
 127             leaf near-rt-ric-id {\r
 128                 type string;\r
 129             }\r
 130             leaf policy-type-id {\r
 131                 type uint32;\r
 132             }\r
 133         }\r
 134 \r
 135         output {\r
 136             leaf-list policy-instance-id-list {\r
 137                 type string;\r
 138             }\r
 139         }\r
 140     }\r
 141 \r
 142     //Create a policy instance\r
 143     rpc createPolicyInstance {\r
 144         input {\r
 145             leaf near-rt-ric-id {\r
 146                 type string;\r
 147             }\r
 148             leaf policy-type-id {\r
 149                 type uint32;\r
 150             }\r
 151             leaf policy-instance-id {\r
 152                 type string;\r
 153             }\r
 154             leaf policy-instance {\r
 155                 type string;\r
 156             }\r
 157         }\r
 158     }\r
 159     \r
 160     ///Get a policy instance\r
 161     rpc getPolicyInstance {\r
 162         input {\r
 163             leaf near-rt-ric-id {\r
 164                 type string;\r
 165             }\r
 166             leaf policy-type-id {\r
 167                 type uint32;\r
 168             }\r
 169             leaf policy-instance-id {\r
 170                 type string;\r
 171             }\r
 172         }\r
 173         output {\r
 174             leaf policy-instance {\r
 175                 type string;\r
 176             }\r
 177         }\r
 178     }\r
 179     \r
 180     //Delete a policy instance\r
 181     rpc deletePolicyInstance {\r
 182         input {\r
 183             leaf near-rt-ric-id {\r
 184                 type string;\r
 185             }\r
 186             leaf policy-type-id {\r
 187                 type uint32;\r
 188             }\r
 189             leaf policy-instance-id {\r
 190                 type string;\r
 191             }\r
 192         }\r
 193     }\r
 194 \r
 195     //Get the status for a policy instance\r
 196     rpc getStatus {\r
 197         input {\r
 198             leaf near-rt-ric-id {\r
 199                 type string;\r
 200             }\r
 201             leaf policy-type-id {\r
 202                 type uint32;\r
 203             }\r
 204             leaf policy-instance-id {\r
 205                 type string;\r
 206             }\r
 207         }\r
 208         output {\r
 209             leaf status {\r
 210                 type string;\r
 211             }\r
 212         }\r
 213     }\r
 214 }