331574d926
Clean up python build warnings to enable warning-is-error. Adding a simple doc page for the api Part of doc-migration work Change-Id: Ia6ad528c207e194c3b48155a8f9f4e67dafb792d
41 lines
1.2 KiB
ReStructuredText
41 lines
1.2 KiB
ReStructuredText
Python bindings to the OpenStack Workflow API
|
|
=============================================
|
|
|
|
This is a client for OpenStack Mistral API. There's a Python API
|
|
(the :mod:`mistralclient` module), and a command-line script
|
|
(installed as :program:`mistral`).
|
|
|
|
Using mistralclient
|
|
-------------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
cli_usage_with_openstack
|
|
cli_usage_with_keycloak
|
|
cli_usage_without_auth
|
|
class_reference
|
|
|
|
For information about using the mistral command-line client, see
|
|
`Workflow service command-line client`_.
|
|
|
|
.. _Workflow service command-line client: https://docs.openstack.org/cli-reference/mistral.html
|
|
|
|
Python API Reference
|
|
--------------------
|
|
|
|
* `REST API Specification`_
|
|
|
|
.. _REST API Specification: https://docs.openstack.org/mistral/latest/api/v2.html
|
|
|
|
Contributing
|
|
------------
|
|
|
|
Code is hosted `on GitHub`_. Submit bugs to the python-mistralclient project on
|
|
`Launchpad`_. Submit code to the openstack/python-mistralclient project
|
|
using `Gerrit`_.
|
|
|
|
.. _on GitHub: https://github.com/openstack/python-mistralclient
|
|
.. _Launchpad: https://launchpad.net/python-mistralclient
|
|
.. _Gerrit: http://docs.openstack.org/infra/manual/developers.html#development-workflow
|