pingu_98/MrDraw
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #793 from imrahil/fix_in_apidocs

Browse source 
Fixed docs for BlueprintPlugin
This commit is contained in:
Gina Häußge 2015-03-04 16:59:33 +01:00
commit bcc724df2c
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/octoprint/plugin/types.py
View file

@ -600,18 +600,18 @@ class BlueprintPlugin(OctoPrintPlugin):
return flask.make_response("Expected a text to echo back.", 400)
return flask.request.values["text"]
__plugin_implementations__ = [MyPlugin()]
__plugin_implementations__ = [MyBlueprintPlugin()]
Your blueprint will be published by OctoPrint under the base URL ``/plugin/<plugin identifier>/``, so the above
example of a plugin with the identifier "myblueprintplugin" would be reachable under
``/plugin/myblueprintplugin/echo``.
Just like with regular blueprints you'll be able to create URLs via ``url_for``, just use the prefix
``plugin.<plugin identifier>``, e.g.:
``plugin.<plugin identifier>.<method_name>``, e.g.:
.. code-block:: python
flask.url_for("plugin.myblueprintplugin.echo") # will return "/plugin/myblueprintplugin/echo"
flask.url_for("plugin.myblueprintplugin.myEcho") # will return "/plugin/myblueprintplugin/echo"
"""