openstack
/
python-ironicclient
Code Issues Proposed changes

Update 'Usage' section in 'doc/source/api_v1.rst' 

When I want to get the client with 'Using Identity Service (keystone)
credentials' section, it will throw errors.(usually http 400)
After testing it is found that two variables aare missing:
  - os_user_domain_name
  - os_project_domain_name
Now added them to the document.

Change-Id: Ibdebc7cf0fc017b7eeb378b022ce5cffcd943fb2
This commit is contained in:
ya.wang 2018-02-09 11:49:12 +08:00
parent 1da269b0e9
commit 9683a7e0c3
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/source/api_v1.rst
View File

@ -61,6 +61,13 @@ These Identity Service credentials can be used to authenticate::
service. default: False (optional)
* os_tenant_{name|id}: name or ID of tenant
Also the following parameters are required when using the Identity API v3::
* os_user_domain_name: name of a domain the user belongs to,
usually 'default'
* os_project_domain_name: name of a domain the project belongs to,
usually 'default'
To create a client, you can use the API like so::
>>> from ironicclient import client