Skip to content
This repository was archived by the owner on Apr 24, 2024. It is now read-only.

Add note in dev.rst about use of the safe option in urllib.quote_plus() #17

Merged
rafaelweingartner merged 1 commit into from
Apr 24, 2018
Merged

Add note in dev.rst about use of the safe option in urllib.quote_plus() #17

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions rtd/source/dev.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,11 @@ Build the request string:
>>> request_str
'apikey=plgWJfZK4gyS3mOMTVmjUVg-X-jlWlnfaUJ9GAbBbf9EdM-kAYMmAiLqzzq1ElZLYq_u38zCm0bewzGUdP66mg&command=listUsers&response=json'

.. note::
If you have API calls which contain * (asterisk) characters, you will need to add the option "safe = '*'" for the URL encoding.
The reason is that Python's urllib will encode * characters by default, while CloudStack's internal encoder does not encode them;
this results in an authentication failure for your API call. In the above you would replace "urllib.quote_plus(request[k])"
with "urllib.quote_plus(request[k], safe='*')".

Compute the signature with hmac, do a 64 bit encoding and a url
encoding:
Expand Down