openstack/python-mistralclient
Code Issues Proposed changes

Enable warning-is-error in doc build

Browse Source 
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
This commit is contained in:
Sharat Sharma 2017-07-12 16:55:28 +05:30
parent fabec4fafc
commit 331574d926
4 changed files with 22 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/source/class_reference.rst Normal file
View File

@ -0,0 +1,7 @@
Python Mistral bindings class refrence
======================================
.. toctree::
:maxdepth: 1
api/autoindex

7
doc/source/index.rst
View File

@ -14,24 +14,25 @@ Using mistralclient
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: http://docs.openstack.org/cli-reference/mistral.html
.. _Workflow service command-line client: https://docs.openstack.org/cli-reference/mistral.html
Python API Reference
--------------------
* `REST API Specification`_
.. _REST API Specification: http://docs.openstack.org/developer/mistral/developer/webapi/v2.html
.. _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-heatclient project
`Launchpad`_. Submit code to the openstack/python-mistralclient project
using `Gerrit`_.
.. _on GitHub: https://github.com/openstack/python-mistralclient

19
mistralclient/auth/keycloak.py
View File

@ -30,25 +30,26 @@ class KeycloakAuthHandler(auth.AuthHandler):
:param req: Request dict containing list of parameters required
for Keycloak authentication.
auth_url: Base authentication url of KeyCloak server (e.g.
* auth_url: Base authentication url of KeyCloak server (e.g.
"https://my.keycloak:8443/auth"
client_id: Client ID (according to OpenID Connect protocol).
client_secret: Client secret (according to OpenID Connect
* client_id: Client ID (according to OpenID Connect protocol).
* client_secret: Client secret (according to OpenID Connect
protocol).
realm_name: KeyCloak realm name.
username: User name (Optional, if None then access_token must be
* realm_name: KeyCloak realm name.
* username: User name (Optional, if None then access_token must be
provided).
password: Password (Optional).
access_token: Access token. If passed, username and password are
* password: Password (Optional).
* access_token: Access token. If passed, username and password are
not used and this method just validates the token and refreshes
it if needed (Optional, if None then username must be
provided).
cacert: SSL certificate file (Optional).
insecure: If True, SSL certificate is not verified (Optional).
* cacert: SSL certificate file (Optional).
* insecure: If True, SSL certificate is not verified (Optional).
:param session: Keystone session object. Not used by this plugin.
"""
if not isinstance(req, dict):
raise TypeError('The input "req" is not typeof dict.')

1
setup.cfg
View File

@ -27,6 +27,7 @@ builders = html,man
source-dir = doc/source
build-dir = doc/build
all_files = 1
warning-is-error = 1
[upload_sphinx]
upload-dir = doc/build/html