Revision a4978169 doc/rapi.rst
| b/doc/rapi.rst | ||
|---|---|---|
| 53 | 53 |
|
| 54 | 54 |
|
| 55 | 55 |
.. [#pwhash] Using the MD5 hash of username, realm and password is |
| 56 |
described in RFC2617_ ("HTTP Authentication"), sections 3.2.2.2 and
|
|
| 56 |
described in :rfc:`2617` ("HTTP Authentication"), sections 3.2.2.2 and
|
|
| 57 | 57 |
3.3. The reason for using it over another algorithm is forward |
| 58 | 58 |
compatibility. If ``ganeti-rapi`` were to implement HTTP Digest |
| 59 | 59 |
authentication in the future, the same hash could be used. |
| ... | ... | |
| 65 | 65 |
-------- |
| 66 | 66 |
|
| 67 | 67 |
The protocol used is JSON_ over HTTP designed after the REST_ principle. |
| 68 |
HTTP Basic authentication as per RFC2617_ is supported.
|
|
| 68 |
HTTP Basic authentication as per :rfc:`2617` is supported.
|
|
| 69 | 69 |
|
| 70 | 70 |
.. _JSON: http://www.json.org/ |
| 71 | 71 |
.. _REST: http://en.wikipedia.org/wiki/Representational_State_Transfer |
| 72 |
.. _RFC2617: http://tools.ietf.org/rfc/rfc2617.txt |
|
| 73 | 72 |
|
| 74 | 73 |
|
| 75 | 74 |
A note on JSON as used by RAPI |
| ... | ... | |
| 108 | 107 |
PUT or POST? |
| 109 | 108 |
------------ |
| 110 | 109 |
|
| 111 |
According to RFC2616 the main difference between PUT and POST is that
|
|
| 112 |
POST can create new resources but PUT can only create the resource the
|
|
| 113 |
URI was pointing to on the PUT request. |
|
| 110 |
According to :rfc:`2616` the main difference between PUT and POST is
|
|
| 111 |
that POST can create new resources but PUT can only create the resource
|
|
| 112 |
the URI was pointing to on the PUT request.
|
|
| 114 | 113 |
|
| 115 | 114 |
Unfortunately, due to historic reasons, the Ganeti RAPI library is not |
| 116 | 115 |
consistent with this usage, so just use the methods as documented below |
Also available in: Unified diff