Skip to content

Commit

Permalink
Updates for 2.6.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
mbj4668 committed Nov 3, 2023
1 parent dc97553 commit 987f59c
Show file tree
Hide file tree
Showing 6 changed files with 1,541 additions and 2,272 deletions.
26 changes: 26 additions & 0 deletions CHANGELOG.md
@@ -1,3 +1,29 @@
* 2.6.0 - 2023-11-03
```
lots of improvements to the UML plugin
thanks to Nick Hancock
lots of improvements to build and test
thanks to @ubaumann
fix invalid regular expression on Windows
thanks to Jan Kundrát
fix script issues on Windows
thanks to Jan Kundrát
fix validation of when expressions for 1.1 modules
thanks to Derek Ingrouville
fixes for revision-date in depend output
thanks to Slavomir Mazur
#845 - sid item status
#844 - tree max line length issue
#837 - test fixes
#821 - typo in jstree output
#818 - issue with decimal64 defaults in json2xml
#809 - revision-date parsed wrong if multiple "@" found in path
thanks to Michael Littlejohn
#729 - handle name scoping of 1.1 submodules in XPath expressions
#516 - crash in tree output
```

* 2.5.3 - 2022-03-30
```
added support for checking 'ancestor' and 'ancestor-or-self' XPATH axes
Expand Down
8 changes: 7 additions & 1 deletion CONTRIBUTORS
Expand Up @@ -11,17 +11,22 @@ Fred Gan
Joe Gladston
Pravin Gohite
Yan Gorelik
Nick Hancock
Giles Heron
Derek Ingrouville
Jozef Janitor
Robin Jarry
Mahesh Jethanandani
Denys Knertser
Mallikarjunarao Kosuri
Miroslav Kovac
Jan Kundrát
Balázs Lengyel
Michael Littlejohn
Miroslav Los
Ladislav Lhotka
William Lupton
Slavomir Mazur
Glenn Matthews
Paul Merlo
Ganesh Nalawade
Expand All @@ -40,6 +45,7 @@ Nick Weeds
Jonathan Yang
Quentin Young
Huaian Zhou
@cygnus2048
@gribok
@lemikev
@cygnus2048
@ubaumann
225 changes: 75 additions & 150 deletions man/man1/json2xml.1
@@ -1,167 +1,92 @@
'\" t
.\" Title: json2xml
.\" Author: Ladislav Lhotka <lhotka@nic.cz>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 2022-03-30
.\" Manual: pyang manual
.\" Source: json2xml-2.5.3
.\" Language: English
.\" Automatically generated by Pandoc 2.9.2.1
.\"
.TH "JSON2XML" "1" "2022\-03\-30" "json2xml\-2\&.5\&.3" "pyang manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
json2xml \- translates JSON documents conforming to a YANG data model into XML\&.
.SH "SYNOPSIS"
.HP \w'\fBjson2xml\fR\ 'u
\fBjson2xml\fR [\-t\ \fItarget\fR] [\-o\ \fIoutput_file\fR] \fIdriver_file\fR \fIjson_file\fR
.HP \w'\fBjson2xml\fR\ 'u
\fBjson2xml\fR \-h | \-\-help
.SH "DESCRIPTION"
.PP
This program translates
\fIjson_file\fR
into XML using the procedure specified in
\m[blue]\fBRFC 7951\fR\m[]\&\s-2\u[1]\d\s+2\&.
.PP
The translation uses a second input file,
\fIdriver_file\fR, which contains a concise JSON representation of the YANG data model to which
\fIjson_file\fR
should conform, at least structurally\&. Normally,
\fIdriver_file\fR
is obtained as the
\fIjtox\fR
output of
\fBpyang\fR\&.
.PP
Using "\-" (hyphen) in place of
\fIjson_file\fR
instructs the program to read a JSON document from the standard input\&.
.PP
The
\fItarget\fR
argument specifies the document (root) element for the output XML document\&. This encapsulation is necessary because the input JSON document may contain multiple JSON objects at the top level\&. Supported values for the
\fItarget\fR
argument are:
.PP
.TH "JSON2XML" "1" "2023-11-03" "json2xml-2.6.0" "User Manual"
.hy
.SH NAME
.PP
json2xml - translates JSON documents conforming to a YANG data model
into XML.
.SH SYNOPSIS
.PP
\f[B]json2xml\f[R] [-t target] [-o \f[I]output_file\f[R]]
\f[I]driver_file\f[R] \f[I]json_file\f[R]
.PP
\f[B]json2xml\f[R] -h | --help
.SH DESCRIPTION
.PP
This program translates \f[I]json_file\f[R] into XML using the procedure
specified in \f[B]RFC 7951\f[R].
.PP
The translation uses a second input file, \f[I]driver_file\f[R], which
contains a concise JSON representation of the YANG data model to which
\f[I]json_file\f[R] should conform, at least structurally.
Normally, \f[I]driver_file\f[R] is obtained as the \f[I]jtox\f[R] output
of \f[B]pyang\f[R].
.PP
Using \[dq]-\[dq] (hyphen) in place of \f[I]json_file\f[R] instructs the
program to read a JSON document from the standard input.
.PP
The \f[I]target\f[R] argument specifies the document (root) element for
the output XML document.
This encapsulation is necessary because the input JSON document may
contain multiple JSON objects at the top level.
Supported values for the \f[I]target\f[R] argument are:
.TP
data
.RS 4
The document element will be <nc:data>\&. This is the default\&.
.RE
.PP
The document element will be <nc:data>.
This is the default.
.TP
config
.RS 4
The document element will be <nc:data>\&.
.RE
.PP
The XML prefix "nc" represents the standard NETCONF namespace with URI "urn:ietf:params:xml:ns:netconf:base:1\&.0"\&.
.SH "OPTIONS"
.PP
\fB\-t\fR \fItarget\fR, \fB\-\-target\fR \fItarget\fR
.RS 4
Specifies the target type of the output XML document, i\&.e\&. its document element\&. The default is
\fBdata\fR\&.
.RE
.PP
\fB\-o\fR \fIoutput_file\fR, \fB\-\-output\fR \fIoutput_file\fR
.RS 4
Write output to
\fIoutput_file\fR
instead of the standard output\&.
.RE
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Displays help screen and exits\&.
.RE
.SH "EXAMPLE"
.sp
.if n \{\
.RS 4
.\}
.nf
$ pyang \-f jtox \-o dhcp\&.jtox dhcp\&.yang
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
The document element will be <nc:data>.
.PP
The XML prefix \[dq]nc\[dq] represents the standard NETCONF namespace
with URI \[dq]urn:ietf:params:xml:ns:netconf:base:1.0\[dq].
.SH OPTIONS
.TP
\f[B]-t\f[R] \f[I]target\f[R], \f[B]target\f[R] \f[I]target\f[R]
Specifies the target type of the output XML document, i.e., its document
element.
The default is \f[B]data\f[R].
.TP
\f[B]-o\f[R] \f[I]output_file\f[R], \f[B]--output\f[R] \f[I]output_file\f[R]
Write output to \f[I]output_file\f[R] instead of the standard output.
.TP
\f[B]-h\f[R], \f[B]--help\f[R]
Displays help screen and exits.
.SH EXAMPLES
.IP
.nf
$ json2xml \-o dhcp\-data\&.xml dhcp\&.jtox dhcp\-data\&.json
\f[C]
$ pyang -f jtox -o dhcp.jtox dhcp.yang

$ json2xml -o dhcp-data.xml dhcp.jtox dhcp-data.json
\f[R]
.fi
.if n \{\
.RE
.\}
.PP
The first command generates the driver file
dhcp\&.jtox, which is then used for translating JSON file
dhcp\-data\&.json
to XML file
dhcp\-data\&.xml\&.
.SH "DIAGNOSTICS"
.PP
\fBjson2xml\fR
return codes have the following meaning:
The first command generates the driver file dhcp.jtox, which is then
used for translating JSON file dhcp-data.json to XML file dhcp-data.xml.
.SH DIAGNOSTICS
.PP
\f[B]json2xml\f[R] return codes have the following meaning:
.TP
0
.RS 4
No error (normal termination)
.RE
.PP
.TP
1
.RS 4
One of the input files cannot be read
.RE
.PP
.TP
2
.RS 4
Error in command line arguments
.RE
.PP
.TP
3
.RS 4
JSON to XML translation failed
.RE
.SH "SEE ALSO"
.SH SEE ALSO
.PP
\m[blue]\fBRFC 7951\fR\m[]\&\s-2\u[1]\d\s+2,
\fBpyang\fR(1),
\m[blue]\fBJSON\fR\m[]\&\s-2\u[2]\d\s+2\&.
.SH "AUTHOR"
\f[B]RFC 7951\f[R], \f[B]pyang\f[R](1)
.SH AUTHOR
.PP
\fBLadislav Lhotka\fR <\&lhotka@nic\&.cz\&>
.br
CZ\&.NIC
.RS 4
.RE
.SH "NOTES"
.IP " 1." 4
RFC 7951
.RS 4
\%http://tools.ietf.org/html/rfc7951
.RE
.IP " 2." 4
JSON
.RS 4
\%http://www.json.org/
.RE
\f[B]Ladislav Lhotka\f[R] <lhotka\[at]nic.cz>
.PD 0
.P
.PD
CZ.NIC

0 comments on commit 987f59c

Please sign in to comment.