ietf-restconf

This module contains conceptual YANG specifications for basic RESTCONF media type definitions used in RESTCONF protocol messages...

  • Version: 2017-01-26

    ietf-restconf@2017-01-26


    
      module ietf-restconf {
    
        yang-version 1.1;
    
        namespace
          "urn:ietf:params:xml:ns:yang:ietf-restconf";
    
        prefix rc;
    
        organization
          "IETF NETCONF (Network Configuration) Working Group";
    
        contact
          "WG Web:   <https://datatracker.ietf.org/wg/netconf/>
    WG List:  <mailto:netconf@ietf.org>
    
    Author:   Andy Bierman
    	  <mailto:andy@yumaworks.com>
    
    Author:   Martin Bjorklund
    	  <mailto:mbj@tail-f.com>
    
    Author:   Kent Watsen
    	  <mailto:kwatsen@juniper.net>";
    
        description
          "This module contains conceptual YANG specifications
    for basic RESTCONF media type definitions used in
    RESTCONF protocol messages.
    
    Note that the YANG definitions within this module do not
    represent configuration data of any kind.
    The 'restconf-media-type' YANG extension statement
    provides a normative syntax for XML and JSON
    message-encoding purposes.
    
    Copyright (c) 2017 IETF Trust and the persons identified as
    authors of the code.  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 Simplified BSD License
    set forth in Section 4.c of the IETF Trust's Legal Provisions
    Relating to IETF Documents
    (http://trustee.ietf.org/license-info).
    
    This version of this YANG module is part of RFC 8040; see
    the RFC itself for full legal notices.";
    
        revision "2017-01-26" {
          description "Initial revision.";
          reference
            "RFC 8040: RESTCONF Protocol.";
    
        }
    
        rc:yang-data "yang-errors";
        rc:yang-data "yang-api";
    
        extension yang-data {
          argument "name" {
            yin-element true;
          }
          description
            "This extension is used to specify a YANG data template that
    represents conceptual data defined in YANG.  It is
    intended to describe hierarchical data independent of
    protocol context or specific message-encoding format.
    Data definition statements within a yang-data extension
    specify the generic syntax for the specific YANG data
    template, whose name is the argument of the 'yang-data'
    extension statement.
    
    Note that this extension does not define a media type.
    A specification using this extension MUST specify the
    message-encoding rules, including the content media type.
    
    The mandatory 'name' parameter value identifies the YANG
    data template that is being defined.  It contains the
    template name.
    
    This extension is ignored unless it appears as a top-level
    statement.  It MUST contain data definition statements
    that result in exactly one container data node definition.
    An instance of a YANG data template can thus be translated
    into an XML instance document, whose top-level element
    corresponds to the top-level container.
    
    The module name and namespace values for the YANG module using
    the extension statement are assigned to instance document data
    conforming to the data definition statements within
    this extension.
    
    The substatements of this extension MUST follow the
    'data-def-stmt' rule in the YANG ABNF.
    
    The XPath document root is the extension statement itself,
    such that the child nodes of the document root are
    represented by the data-def-stmt substatements within
    this extension.  This conceptual document is the context
    for the following YANG statements:
    
      - must-stmt
      - when-stmt
      - path-stmt
      - min-elements-stmt
      - max-elements-stmt
      - mandatory-stmt
      - unique-stmt
      - ordered-by
      - instance-identifier data type
    
    The following data-def-stmt substatements are constrained
    when used within a 'yang-data' extension statement.
    
      - The list-stmt is not required to have a key-stmt defined.
      - The if-feature-stmt is ignored if present.
      - The config-stmt is ignored if present.
      - The available identity values for any 'identityref'
        leaf or leaf-list nodes are limited to the module
        containing this extension statement and the modules
        imported into that module.
    ";
        }
      }  // module ietf-restconf
    

© 2023 YumaWorks, Inc. All rights reserved.