module yumaworks-sm-yanglib {

    yang-version 1.1;

    namespace
      "urn:yumaworks:params:xml:ns:yang:yumaworks-sm-yanglib";

    prefix ysl;

    import ietf-yang-types {
      prefix yang;
    }
    import ietf-yang-library {
      prefix yanglib;
    }

    organization "YumaWorks, Inc.";

    contact
      "Support <support@yumaworks.com>";

    description
      "This module contains configuration parameters
     for the YANG Schema Mount data model defined in RFC 8528.

     Copyright (c) 2022, YumaWorks, Inc. All rights reserved.

     Redistribution and use in source and binary forms, with or
     without modification, is permitted pursuant to, and subject
     to the license terms contained in, the BSD 3-Clause License
     http://opensource.org/licenses/BSD-3-Clause.
   ";

    revision "2022-09-24" {
      description "Initial version";
    }


    rpc get-sm-yanglib {
      description
        "Get the YANG library contents for the specified
       mount point label.  The standard mechanism  is not
       robust or efficient for several reasons:
         - The YANG library is duplicated for every mount
           point instance.
         - The client does not know the ancestor keys for
           any mount point instance so must retrieve all
           instances which is very inefficient since they are
           the same in each instance.
         - The YANG library does not exist until the mount
           point exists.  This creates an ordering problem
           so a client must first create the mount point,
           get the YANG library, and then start using the mounted
           modules.
         - Access control issues can make it difficult to read
           the YANG module inventory, depending on the mount
           point instance and the NACM configuration.

       Support for /modules-state is provided only.
       The NMDA YANG library is only available via a
       normal 'get' or 'get-data' operation on the
       /yang-library subtree.";
      input {
        leaf module {
          type yang:yang-identifier;
          mandatory true;
          description
            "The module containing the mount point extension.";
        }

        leaf label {
          type yang:yang-identifier;
          mandatory true;
          description
            "The mount point label. The server will return YANG library
           information for this mount point only if it is supported
           and enabled in the server.";
        }
      }

      output {
        container modules-state {
          leaf module-set-id {
            type string;
            mandatory true;
            description
              "Leaf from ietf-yang-library.yang";
          }

          list module {
            key "name revision";
            description
              "Each entry represents one revision of one module
currently supported by the server.";
            leaf name {
              type yang:yang-identifier;
              description
                "The YANG module or submodule name.";
            }

            leaf revision {
              type union {
                type revision-identifier;
                type string {
                  length "0";
                }
              }
              description
                "The YANG module or submodule revision date.
A zero-length string is used if no revision statement
is present in the YANG module or submodule.";
            }

            leaf schema {
              type inet:uri;
              description
                "Contains a URL that represents the YANG schema
resource for this module or submodule.

This leaf will only be present if there is a URL
available for retrieval of the schema for this entry.";
            }

            leaf namespace {
              type inet:uri;
              mandatory true;
              description
                "The XML namespace identifier for this module.";
            }

            leaf-list feature {
              type yang:yang-identifier;
              description
                "List of YANG feature names from this module that are
supported by the server, regardless of whether they are
defined in the module or any included submodule.";
            }

            list deviation {
              key "name revision";
              description
                "List of YANG deviation module names and revisions
used by this server to modify the conformance of
the module associated with this entry.  Note that
the same module can be used for deviations for
multiple modules, so the same entry MAY appear
within multiple 'module' entries.

The deviation module MUST be present in the 'module'
list, with the same name and revision values.
The 'conformance-type' value will be 'implement' for
the deviation module.";
              leaf name {
                type yang:yang-identifier;
                description
                  "The YANG module or submodule name.";
              }

              leaf revision {
                type union {
                  type revision-identifier;
                  type string {
                    length "0";
                  }
                }
                description
                  "The YANG module or submodule revision date.
A zero-length string is used if no revision statement
is present in the YANG module or submodule.";
              }
            }  // list deviation

            leaf conformance-type {
              type enumeration {
                enum "implement" {
                  value 0;
                  description
                    "Indicates that the server implements one or more
protocol-accessible objects defined in the YANG module
identified in this entry.  This includes deviation
statements defined in the module.

For YANG version 1.1 modules, there is at most one
module entry with conformance type 'implement' for a
particular module name, since YANG 1.1 requires that,
at most, one revision of a module is implemented.

For YANG version 1 modules, there SHOULD NOT be more
than one module entry for a particular module name.";
                }
                enum "import" {
                  value 1;
                  description
                    "Indicates that the server imports reusable definitions
from the specified revision of the module but does
not implement any protocol-accessible objects from
this revision.

Multiple module entries for the same module name MAY
exist.  This can occur if multiple modules import the
same module but specify different revision dates in
the import statements.";
                }
              }
              mandatory true;
              description
                "Indicates the type of conformance the server is claiming
for the YANG module identified by this entry.";
            }

            list submodule {
              key "name revision";
              description
                "Each entry represents one submodule within the
parent module.";
              leaf name {
                type yang:yang-identifier;
                description
                  "The YANG module or submodule name.";
              }

              leaf revision {
                type union {
                  type revision-identifier;
                  type string {
                    length "0";
                  }
                }
                description
                  "The YANG module or submodule revision date.
A zero-length string is used if no revision statement
is present in the YANG module or submodule.";
              }

              leaf schema {
                type inet:uri;
                description
                  "Contains a URL that represents the YANG schema
resource for this module or submodule.

This leaf will only be present if there is a URL
available for retrieval of the schema for this entry.";
              }
            }  // list submodule
          }  // list module
        }  // container modules-state
      }
    }  // rpc get-sm-yanglib
  }  // module yumaworks-sm-yanglib