[NETCONF-212] API Doc Explorer broken due to index.html:1 Uncaught SyntaxError: Unexpected token } in JSON at position 6398 index.html:1 Uncaught SyntaxError: Unexpected token } in JSON at position 1234

Fri, 15 Mar 2019 22:22:25 +0000

When I try to use the http://localhost:8181/apidoc/explorer/index.html API Doc Explorer of the basic Hello example (https://wiki.opendaylight.org/view/OpenDaylight_Controller:MD-SAL:Startup_Project_Archetype) right now, then it appears to be broken. It used to work for me (before?) last week, but right now does not anymore.

The home page actually does still show up, but "Show/Hide", "List Operations" and "Expand Operations" all do not work.

Chrome's Console shows: "index.html:1 Uncaught SyntaxError: Unexpected token } in JSON at position ..." and under Firefox Console has "SyntaxError: JSON.parse: expected ':' after property name in object at line 1 column 584 of the JSON data swagger.js:308:26"

The root cause is that the JSON returned by netconf/restconf/sal-rest-docgen is invalid (in some case/s). Specifically, I'm seeing the following pattern, when debugging through JS in browser but also with that "Raw" link available on every line on the Web UI:

{"apiVersion":"1.0.0","swaggerVersion":"1.2", ..., "models"}

Note that "models" is a JSON key with the ':' and value missing!

~~NETCONF-116~~'s error message does not appear in the logs.

OpenDaylight JIRA

[NETCONF-212] API Doc Explorer broken due to index.html:1 Uncaught SyntaxError: Unexpected token } in JSON at position 6398 index.html:1 Uncaught SyntaxError: Unexpected token } in JSON at position 1234