Add docstring for plugin_scope

This patch adds the missing docstring of the request handler for
/NetworkDriver.GetCapabilities.

Change-Id: I84556e294aba3627b38fc4a99830c07eb7c1bf30
Signed-off-by: Taku Fukushima <f.tac.mac@gmail.com>
This commit is contained in:
Taku Fukushima 2015-12-02 16:30:38 +09:00
parent 7cd5da8207
commit eb5b546171
1 changed files with 11 additions and 0 deletions

View File

@ -302,6 +302,17 @@ def plugin_activate():
@app.route('/NetworkDriver.GetCapabilities', methods=['POST'])
def plugin_scope():
"""Returns the capability as the remote network driver.
This function returns the capability of the remote network driver, which is
``global`` or ``local`` and defaults to ``global``. With ``global``
capability, the network information is shared among multipe Docker daemons
if the distributed store is appropriately configured.
See the following link for more details about the spec:
https://github.com/docker/libnetwork/blob/master/docs/remote.md#set-capability # noqa
"""
capabilities = {'Scope': cfg.CONF.capability_scope}
return flask.jsonify(capabilities)