api/src/main/yang/tapi@2018-09-28.yang

   1 module tapi {
   2   yang-version 1;
   3   namespace "urn:opendaylight:params:xml:ns:yang:tapi";
   4   prefix tapi;
   5
   6   import tapi-topology {
   7     prefix tapi-topology;
   8     revision-date 2018-12-10;
   9   }
  10   import tapi-common {
  11     prefix tapi-common;
  12     revision-date 2018-12-10;
  13   }
  14   import org-openroadm-common-service-types {
  15     prefix org-openroadm-common-service-types;
  16   }
  17
  18   organization
  19     "transportPCE";
  20   contact
  21     "transportPCE committers - ODL";
  22   description
  23     "YANG definitions for using REST API in TAPI module. Copyright
  24      (c) 2018 ORANGE and others. All rights reserved. authors: Gilles
  25      Thouenon ( gilles.thouenon@orange.com ) Christophe Betoule ( christophe.betoule@orange.com
  26      )";
  27
  28   revision 2018-09-28 {
  29     description
  30       "Initial revision of TAPI model for internal use";
  31   }
  32
  33   typedef end-point-type {
  34     type enumeration {
  35       enum Aend {
  36         value 1;
  37       }
  38       enum Zend {
  39         value 2;
  40       }
  41     }
  42     description
  43       "help to identify if the generic service end point is usable as a service termination for A or Z end-point";
  44   }
  45
  46   rpc load-topology {
  47     input {
  48       leaf topology-name {
  49         type string;
  50         description
  51           "none";
  52       }
  53       container topology {
  54         description
  55           "none";
  56         uses tapi-topology:topology;
  57       }
  58     }
  59     output {
  60       leaf success {
  61         type boolean;
  62       }
  63       leaf result {
  64         type string;
  65       }
  66     }
  67   }
  68
  69   container service-interface-points {
  70     list service-end-point {
  71       key "uuid";
  72       description
  73         "List of service-interface-point from tapi-topology available
  74          for an org-openroadm-service usage";
  75       leaf uuid {
  76         type tapi-common:uuid;
  77       }
  78       container end-point {
  79         leaf service-end-point-type {
  80           type end-point-type;
  81         }
  82         uses org-openroadm-common-service-types:service-endpoint;
  83       }
  84     }
  85   }
  86 }