Revision 7421af4a
| b/Changelog | ||
|---|---|---|
| 67 | 67 |
* API-related changes: |
| 68 | 68 |
|
| 69 | 69 |
* Implemented API calls for quota, resources, and commissions. |
| 70 |
* Moved all API calls under '/astakos/api'. Kept also previous locations
|
|
| 70 |
* Moved all API calls under '/account/v1.0'. Kept also previous locations
|
|
| 71 | 71 |
for backwards compatibility. |
| 72 | 72 |
|
| 73 | 73 |
* Changes in views: |
| b/docs/astakos-api-guide.rst | ||
|---|---|---|
| 89 | 89 |
|
| 90 | 90 |
Authenticate API requests require a token. An application that wishes to connect to Astakos, but does not have a token, should redirect the user to ``/login``. (see :ref:`authentication-label`) |
| 91 | 91 |
|
| 92 |
============================= ========= ================== |
|
| 93 |
Uri Method Description |
|
| 94 |
============================= ========= ================== |
|
| 95 |
``/astakos/api/authenticate`` GET Authenticate user using token
|
|
| 96 |
============================= ========= ================== |
|
| 92 |
============================== ========= ==================
|
|
| 93 |
Uri Method Description
|
|
| 94 |
============================== ========= ==================
|
|
| 95 |
``/account/v1.0/authenticate`` GET Authenticate user using token
|
|
| 96 |
============================== ========= ==================
|
|
| 97 | 97 |
|
| 98 | 98 |
| |
| 99 | 99 |
|
| ... | ... | |
| 149 | 149 |
|
| 150 | 150 |
Post user feedback. |
| 151 | 151 |
|
| 152 |
========================= ========= ================== |
|
| 153 |
Uri Method Description |
|
| 154 |
========================= ========= ================== |
|
| 155 |
``/astakos/api/feedback`` POST Send feedback
|
|
| 156 |
========================= ========= ================== |
|
| 152 |
========================== ========= ==================
|
|
| 153 |
Uri Method Description
|
|
| 154 |
========================== ========= ==================
|
|
| 155 |
``/account/v1.0/feedback`` POST Send feedback
|
|
| 156 |
========================== ========= ==================
|
|
| 157 | 157 |
|
| 158 | 158 |
| |
| 159 | 159 |
|
| ... | ... | |
| 192 | 192 |
|
| 193 | 193 |
Return a json formatted dictionary containing information about a specific user |
| 194 | 194 |
|
| 195 |
================================ ========= ==================
|
|
| 196 |
Uri Method Description
|
|
| 197 |
================================ ========= ==================
|
|
| 198 |
``/astakos/api/user_catalogs`` POST Get 2 catalogs containing uuid to displayname mapping and the opposite
|
|
| 199 |
================================ ========= ==================
|
|
| 195 |
=============================== ========= ================== |
|
| 196 |
Uri Method Description |
|
| 197 |
=============================== ========= ================== |
|
| 198 |
``/account/v1.0/user_catalogs`` POST Get 2 catalogs containing uuid to displayname mapping and the opposite
|
|
| 199 |
=============================== ========= ================== |
|
| 200 | 200 |
|
| 201 | 201 |
| |
| 202 | 202 |
|
| ... | ... | |
| 253 | 253 |
|
| 254 | 254 |
Return a json formatted dictionary containing information about a specific user |
| 255 | 255 |
|
| 256 |
====================================== ========= ================== |
|
| 257 |
Uri Method Description |
|
| 258 |
====================================== ========= ================== |
|
| 259 |
``/astakos/api/service/user_catalogs`` POST Get 2 catalogs containing uuid to displayname mapping and the opposite
|
|
| 260 |
====================================== ========= ================== |
|
| 256 |
======================================= ========= ==================
|
|
| 257 |
Uri Method Description
|
|
| 258 |
======================================= ========= ==================
|
|
| 259 |
``/account/v1.0/service/user_catalogs`` POST Get 2 catalogs containing uuid to displayname mapping and the opposite
|
|
| 260 |
======================================= ========= ==================
|
|
| 261 | 261 |
|
| 262 | 262 |
| |
| 263 | 263 |
|
| b/docs/astakos.rst | ||
|---|---|---|
| 90 | 90 |
Alice requests a specific resource from a cloud service ex. Pithos. In the |
| 91 | 91 |
request supplies the `X-Auth-Token` to identify whether she is eligible to |
| 92 | 92 |
perform the specific task. The service contacts Astakos through its |
| 93 |
``/astakos/api/authenticate`` api call (see :ref:`authenticate-api-label`)
|
|
| 93 |
``/account/v1.0/authenticate`` api call (see :ref:`authenticate-api-label`)
|
|
| 94 | 94 |
providing the specific ``X-Auth-Token``. Astakos checkes whether the token |
| 95 | 95 |
belongs to an active user and it has not expired and returns a dictionary |
| 96 | 96 |
containing user related information. Finally the service uses the ``uniq`` |
| b/docs/quota-api-guide.rst | ||
|---|---|---|
| 10 | 10 |
Get Resource List |
| 11 | 11 |
................. |
| 12 | 12 |
|
| 13 |
**GET** /astakos/api/resources
|
|
| 13 |
**GET** /account/v1.0/resources
|
|
| 14 | 14 |
|
| 15 | 15 |
This call returns a description for each resource available in the system. |
| 16 | 16 |
The response consists of a dictionary, indexed by the resource name, which |
| ... | ... | |
| 59 | 59 |
Get Quotas |
| 60 | 60 |
.......... |
| 61 | 61 |
|
| 62 |
**GET** /astakos/api/quotas
|
|
| 62 |
**GET** /account/v1.0/quotas
|
|
| 63 | 63 |
|
| 64 | 64 |
==================== ========================= |
| 65 | 65 |
Request Header Name Value |
| ... | ... | |
| 119 | 119 |
Get Quotas per Service |
| 120 | 120 |
...................... |
| 121 | 121 |
|
| 122 |
**GET** /astakos/api/service_quotas
|
|
| 122 |
**GET** /account/v1.0/service_quotas
|
|
| 123 | 123 |
|
| 124 | 124 |
==================== ============================ |
| 125 | 125 |
Request Header Name Value |
| ... | ... | |
| 195 | 195 |
Issue Commission |
| 196 | 196 |
................ |
| 197 | 197 |
|
| 198 |
**POST** /astakos/api/commissions
|
|
| 198 |
**POST** /account/v1.0/commissions
|
|
| 199 | 199 |
|
| 200 | 200 |
==================== ============================ |
| 201 | 201 |
Request Header Name Value |
| ... | ... | |
| 294 | 294 |
Get Pending Commissions |
| 295 | 295 |
....................... |
| 296 | 296 |
|
| 297 |
**GET** /astakos/api/commissions
|
|
| 297 |
**GET** /account/v1.0/commissions
|
|
| 298 | 298 |
|
| 299 | 299 |
==================== ============================ |
| 300 | 300 |
Request Header Name Value |
| ... | ... | |
| 326 | 326 |
Get the Description of a Commission |
| 327 | 327 |
................................... |
| 328 | 328 |
|
| 329 |
**GET** /astakos/api/commissions/<serial>
|
|
| 329 |
**GET** /account/v1.0/commissions/<serial>
|
|
| 330 | 330 |
|
| 331 | 331 |
==================== ============================ |
| 332 | 332 |
Request Header Name Value |
| ... | ... | |
| 374 | 374 |
Accept or Reject a Commission |
| 375 | 375 |
............................. |
| 376 | 376 |
|
| 377 |
**POST** /astakos/api/commissions/<serial>/action
|
|
| 377 |
**POST** /account/v1.0/commissions/<serial>/action
|
|
| 378 | 378 |
|
| 379 | 379 |
==================== ============================ |
| 380 | 380 |
Request Header Name Value |
| ... | ... | |
| 416 | 416 |
Accept or Reject Multiple Commissions |
| 417 | 417 |
..................................... |
| 418 | 418 |
|
| 419 |
**POST** /astakos/api/commissions/action
|
|
| 419 |
**POST** /account/v1.0/commissions/action
|
|
| 420 | 420 |
|
| 421 | 421 |
==================== ============================ |
| 422 | 422 |
Request Header Name Value |
Also available in: Unified diff