api/src/main/yang/tapi@2023-07-28.yang

   1 module tapi {
   2   yang-version 1.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 2022-11-21;
   9   }
  10   import tapi-common {
  11     prefix tapi-common;
  12     revision-date 2022-11-21;
  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 "2023-07-28" {
  29     description
  30       "Second revision of TAPI model for migration towards TAPI 2.4";
  31   }
  32   revision 2018-09-28 {
  33     description
  34       "Initial revision of TAPI model for internal use";
  35   }
  36
  37   typedef end-point-type {
  38     type enumeration {
  39       enum Aend {
  40         value 1;
  41       }
  42       enum Zend {
  43         value 2;
  44       }
  45     }
  46     description
  47       "help to identify if the generic service end point is usable as a service termination for A or Z end-point";
  48   }
  49
  50   rpc load-topology {
  51     input {
  52       leaf topology-name {
  53         type string;
  54         description
  55           "none";
  56       }
  57       container topology {
  58         description
  59           "none";
  60         uses tapi-topology:topology;
  61       }
  62     }
  63     output {
  64       leaf success {
  65         type boolean;
  66       }
  67       leaf result {
  68         type string;
  69       }
  70     }
  71   }
  72
  73   container service-interface-points {
  74     list service-end-point {
  75       key "uuid";
  76       description
  77         "List of service-interface-point from tapi-topology available
  78          for an org-openroadm-service usage";
  79       leaf uuid {
  80         type tapi-common:uuid;
  81       }
  82       container end-point {
  83         leaf service-end-point-type {
  84           type end-point-type;
  85         }
  86         uses org-openroadm-common-service-types:service-endpoint;
  87       }
  88     }
  89   }
  90 }