juju schema doesn't contain docs

[Jeff Pihach]

The current js libjuju contains full documentation[0] for the Juju API. This was possible because the old schema contained a segment[1] for the documentation. It would be great if we could add that back in so that we can retain this documentation going forward. As I understand it, it's the only source of documentation for the Juju API.

ex)

      "Name": "Action",
      "Version": 2,
      "Doc": "ActionAPI implements the client API for interacting with Actions\n",
      "Methods": [
        {
          "Name": "Actions",
          "Doc": "Actions takes a list of ActionTags, and returns the full Action for\neach ID.\n",
          "Param": {
            "Name": "github.com/juju/juju/apiserver/params#Entities"
          },
          "Result": {
            "Name": "github.com/juju/juju/apiserver/params#ActionResults"
          }
        },

[0] https://github.com/juju/js-libjuju/blob/master/api/doc/action-v2.md
[1] https://github.com/juju/js-libjuju/blob/master/schemas/schema.json starts at line 27077

[Simon Richardson (simonrichardson)]

So I noticed this was broken sometime ago. I did spend a very short bit of time attempting to replicate it in juju/juju directly, so that you always had the latest documentation against the code itself. It's not finished and any updates will be gratefully appreciated and if somebody wants to update it with the latest Canonical branding, then I would be over the moon with that.

The documentation for how you view it is here https://discourse.juju.is/t/schemadocs/1945

[Simon Richardson (simonrichardson)]

PR with type and method documentation: https://github.com/juju/juju/pull/11686