https://jira.opendaylight.org This file is an XML representation of an issue en-us 8.20.10 820010 22-06-2022 https://jira.opendaylight.org/browse/CONTROLLER-477 controller <p>Currently there's no trailing newline to formatted JSON output. This can be annoying when using command-line tools to interact with the REST API.</p> <p>Though there's also something to be said for <em>not</em> pretty-printing the output by default also since this increases the size of the messages.</p> <p>Workaround is something like feeding the output into a JSON formatter such as python -mjson.tool.</p> <p>Operating System: Linux<br/> Platform: PC</p> CONTROLLER-477

Add trailing newline to formatted JSON output

Improvement Resolved Done Jozef Gloncak Rob Adams Wed, 14 May 2014 23:43:53 +0000 Tue, 14 Nov 2017 15:18:00 +0000 Mon, 7 Jul 2014 11:24:15 +0000 Helium restconf 0 8 <p>I personally would argue that the response should NOT be pretty-printed and it should be up to the receiver to format the results. When you get large, nested outputs, whitespace can add up to be a significant portion of the result.</p> <p>With that said, we could add a header argument / query param which would optionally pretty-format the result if provided. </p> <p>==</p> <p>My proposal - Best of both worlds - by default do NOT pretty-print the output, but allow for either a query param or header value (query param is probably easier) which pretty-prints the response content in the server before return it to the caller.</p> <p>This will increase usability for developers relying on command line tools etc.</p> <p>Thoughts?</p> <p>The RESTCONF draft does define a "format" query parameter:</p> <p> The "format" parameter is used to specify the format of any content<br/> returned in the response. Note that this parameter MAY be used<br/> instead of the "Accept" header to identify the format desired in the<br/> response.</p> <p> The "format" parameter is only supported for the GET and HEAD<br/> methods. It is supported for all RESTCONF media types.</p> <p> syntax: format= xml | json</p> <p>Although the draft doesn't mention about pretty-printing, we could use "format" to indicate pretty-printed output (as an extension to the draft).</p> <p>I'm fine with never pretty-printing or with doing it from a config option in a config file somewhere. I think the bug about formatting errors as JSON is fixed now so the "pipe curl into python -mjson.tool" works just fine.</p> <p>patch set was proposed<br/> <a href="https://git.opendaylight.org/gerrit/#/c/8329" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/#/c/8329</a></p> <p>if in URI is specified parameter includeWhiteChars=false then no white characters will be present in JSON|XML output.</p> <p>if includeWhiteChars is omitted or contains any other value, the white characters will be present in output.</p> <p>Comment from patch set:<br/> &gt;&gt;&gt;&gt;<br/> Rob Adams<br/> First, it should be called prettyPrint not includeWhiteSpaces.</p> <p>Second the default should be <em>not</em> to pretty print. So change to prettyPrint=true. The normal operational mode would be to not pretty print, and it's silly to require all calls to the REST API to pass this extra parameter in normal operation.<br/> &lt;&lt;&lt;&lt;</p> <p>patch set 3 was proposed</p> <ul class="alternate" type="square"> <li>URI parameter was renamed to prettyPrint</li> <li>behaviour was changed:</li> <li>- if prettyPrint=true - output is pretty printed</li> <li>- other cases - output isn't pretty printed.</li> </ul> <p><a href="https://git.opendaylight.org/gerrit/#/c/8329" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/#/c/8329</a></p> <p>patch set 4 was uploaded. parameter of type UriInfo was added to signatures of method which were specified by Devin Avery</p> <p>patch set which add UriInfo input parameter to once more missing method</p> <p>patch set 8 which solve conflicts with current master was uploaded.</p> Blocks CONTROLLER-287 Development External issue ID 1016 External issue URL Rank 0|i02kn3: