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