Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

apiserver/facade: add Registry.ListDetails method #7331

Merged

Conversation

rogpeppe
Copy link
Contributor

@rogpeppe rogpeppe commented May 11, 2017

We add a ListDetails method to obtain information
on the available facades and also add AdminFacadeDetails in apiserver
for the Admin facade, which isn't available from apiserver.AllFacades.

This enables an external program to obtain information about
the juju API, for example to generate documentation
automatically or to do static compatibility checks.

Also export IsControllerFacade and IsModelFacade so that it's
possible to tell which facades are available in which mode.
In the future, it would be nice to be able to find which facades
are available to users as opposed to agents, but that's for
another PR.

Also remove some unused cruft from the tests (we only have
one admin facade version at the moment).

QA:

go get github.com/rogpeppe/misc/cmd/jujuapidoc github.com/rogpeppe/misc/cmd/jujuapidochtml
jujuapidoc > /tmp/apidoc.json
jujuapidochtml /tmp/apidoc.json > /tmp/apidoc.html
open /tmp/apidoc.html
# observe the beauty of the Juju API.

@rogpeppe rogpeppe force-pushed the 076-apiserver-facade-list-details branch 2 times, most recently from 2713512 to a8dabcb Compare May 11, 2017 18:01
logDir string
limiter utils.Limiter
validator LoginValidator
adminAPIFactories map[int]adminAPIFactory
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the only field removed.

Also add AdminFacadeDetails in apiserver.
@rogpeppe rogpeppe force-pushed the 076-apiserver-facade-list-details branch from a8dabcb to 2183fbd Compare May 11, 2017 18:06
@rogpeppe
Copy link
Contributor Author

$$merge$$

@jujubot
Copy link
Collaborator

jujubot commented May 12, 2017

Status: merge request accepted. Url: http://juju-ci.vapour.ws:8080/job/github-merge-juju

@jujubot jujubot merged commit 094c684 into juju:develop May 12, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants