api/src/main/yang/gnpy-api@2022-02-21.yang

   1 module gnpy-api {
   2   yang-version 1.1;
   3   namespace "gnpy:gnpy-api";
   4   prefix gnpyapi;
   5
   6   import gnpy-network-topology {
   7     prefix gnpynt;
   8   }
   9   import gnpy-path-computation-simplified {
  10     prefix gnpypc;
  11   }
  12   import gnpy-eqpt-config {
  13     prefix gnpyeqpt;
  14   }
  15
  16   organization
  17     "Telecom Infra Project OOPT PSE Working Group";
  18   contact
  19     "WG Web:   <https://github.com/Telecominfraproject/oopt-gnpy>
  20      contact:  <mailto:ahmed.triki@orange.com>
  21      contact:  <mailto:esther.lerouzic@orange.com>
  22     ";
  23   description
  24     "YANG model for gnpy api input for path computation -
  25     The license used for all the yang files of GNPy is BSD 3-Clause License
  26
  27     BSD 3-Clause License
  28
  29     Copyright (c) 2018, Telecom Infra Project
  30     All rights reserved.
  31
  32     Redistribution and use in source and binary forms, with or without
  33     modification, are permitted provided that the following conditions are met:
  34
  35     * Redistributions of source code must retain the above copyright notice, this
  36       list of conditions and the following disclaimer.
  37
  38     * Redistributions in binary form must reproduce the above copyright notice,
  39       this list of conditions and the following disclaimer in the documentation
  40       and/or other materials provided with the distribution.
  41
  42     * Neither the name of the copyright holder nor the names of its
  43       contributors may be used to endorse or promote products derived from
  44       this software without specific prior written permission.
  45
  46     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS'
  47     AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  48     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  49     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  50     FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  51     DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  52     SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  53     CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  54     OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  55     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.";
  56
  57   revision 2022-02-21 {
  58     description
  59       "draft for GNPy4TPCE preversion - non official version relevant for v2.4 GNPy file format";
  60     reference
  61       "YANG model for api input for path computation with gnpy";
  62   }
  63
  64   revision 2020-10-22 {
  65     description
  66       "draft for experimental/2020-candi";
  67     reference
  68       "YANG model for api input for path computation with gnpy";
  69   }
  70
  71   revision 2019-01-03 {
  72     description
  73       "first draft for GNPy4TPCE preversion - non official version relevant for v1.2 GNPy file format";
  74     reference
  75       "YANG model for api input for path computation with gnpy";
  76   }
  77
  78   container request {
  79     container service {
  80       description
  81         "Describe the service file to connect to gnpy";
  82       uses gnpypc:service;
  83     }
  84     container topology {
  85       description
  86         "Describe the topology file to connect to gnpy";
  87       uses gnpynt:topo;
  88     }
  89     container equipment {
  90       description
  91         "Describe the equipment library to connect to gnpy";
  92       uses gnpyeqpt:eqpt;
  93     }
  94   }
  95
  96
  97 }