Skip to content
Permalink
Browse files

doc: add release notes

link in release notes will only work after PR is accepted
  • Loading branch information...
rhwood committed May 12, 2019
1 parent fc8a38e commit 2db3fbe18620aed326a214a4efa9858cdf2f75d3
Showing with 14 additions and 7 deletions.
  1. +8 −1 help/en/releasenotes/current-draft-note.shtml
  2. +6 −6 java/src/jmri/server/json/package-info.java
@@ -453,7 +453,14 @@
<h3>Web Access</h3>
<a id="WA" name="WA"></a>
<ul>
<li> </li>
<li>JSON clients can now add, edit, or remove IdTags, Reporters, Operations Locations, Operations Cars, Operations
Engines, and Operations Tracks.</li>
<li>JSON clients using WebSockets can now include an <code>id</code> property in the message to match a direct response
to a message to the original message.</li>
<li><strong>Warning</strong> the JSON protocol version has been bumped to version 5.0 due to backwards incompatible
changes to make different JSON objects more internally consistent and to accomodate the ability to remove some
objects. See the JSON <a href="http://jmri.org/JavaDoc/doc/jmri/server/json/package-summary.html#history">Version History</a>
for more details.</li>
</ul>

<h3>WiThrottle Server</h3>
@@ -3,7 +3,7 @@
* RESTful interface over HTTP or via JSON messages via a socket interface over
* TCP or WebSockets.
*
* <h2>Schema</h2>
* <h2 id="schema">Schema</h2>
*
* The JMRI JSON protocol has two sets of schema, one for messages from clients
* to a JMRI server, and one for messages from a JMRI server to clients. The
@@ -21,7 +21,7 @@
* and individual schema for each data object type at <a href=
* "http://localhost:12080/json/schema/type">http://my-jmri-server:12080/json/schema/<em>type</em></a>
*
* <h2>Methods</h2>
* <h2 id="methods">Methods</h2>
*
* The JMRI JSON services accept four methods, all of which directly correspond
* to HTTP 1.1 methods. The socket services accept one non-HTTP 1.1 method
@@ -52,7 +52,7 @@
* <code>GET</code> request to <code>/json/&lt;type&gt;</code>.</dd>
* </dl>
*
* <h2>Messages</h2>
* <h2 id="messages">Messages</h2>
* <p>
* Fundamentally, the JSON server passes messages as JSON Objects between a JMRI
* server and one or more clients. In the TCP Socket and WebSocket interfaces, a
@@ -81,7 +81,7 @@
* corresponds to the <code>data</code> object in the socket interfaces.
* </p>
*
* <h3>Exceptions</h3>
* <h3 id="exceptions">Exceptions</h3>
* <p>
* Exceptions to the above form for the socket interfaces are:
* </p>
@@ -131,7 +131,7 @@
* generally safer to always use system names.
* </p>
*
* <h2>Version History</h2>
* <h2 id="history">Version History</h2>
* <p>
* Changes to the major number represent a backwards incompatible change in the
* protocol, while changes to the minor number represent an addition to the
@@ -190,7 +190,7 @@
* <dd>Initial release of JMRI JSON Protocol.</dd>
* </dl>
*
* <h2>Notes</h2>
* <h2 id="notes">Notes</h2>
* <p>
* The JMRI JSON services are defined using {@link jmri.spi.JsonServiceFactory}
* objects which may be loaded as third-party plug-ins to JMRI (see <a href=

0 comments on commit 2db3fbe

Please sign in to comment.
You can’t perform that action at this time.