Skip to content
Snippets Groups Projects
Commit 2ddff68e authored by Marek Chrastina's avatar Marek Chrastina
Browse files

Manual test

parent ae8214ee
No related branches found
No related tags found
6 merge requests!368Update prace.md to document the change from qprace to qprod as the default...,!367Update prace.md to document the change from qprace to qprod as the default...,!366Update prace.md to document the change from qprace to qprod as the default...,!323extended-acls-storage-section,!196Master,!178Apidocs
Hide whitespace changes
Inline Side-by-side
Showing
with 23 additions and 23 deletions
docs.it4i/apidocs.md
+ 23
− 23
View file @ 2ddff68e
# API Documentation API Documentation
============================================================================================================= =============================================================================================================
Implements API for IT4I SCS Information System. Implements API for IT4I SCS Information System.
- api revision: `9eb0678f / 2017-12-08 11:06:12 +0100` - api revision: **9eb0678f / 2017-12-08 11:06:12 +0100**
- api version: `0.9-11-g9eb0678` - api version: **0.9-11-g9eb0678**
- apidoc building date: `2017-12-11 15:00:03 +0100` - apidoc building date: **2017-12-11 15:19:33 +0100**
## Summary Summary
------------------------------------------------------------------------------------- -------------------------------------------------------------------------------------
<table> <table>
...@@ -97,10 +97,10 @@ Implements API for IT4I SCS Information System. ...@@ -97,10 +97,10 @@ Implements API for IT4I SCS Information System.
</tbody> </tbody>
</table> </table>
## API Details API Details
--------------------------------------------------------------------------------------------- ---------------------------------------------------------------------------------------------
### GET /api/v1/account-expire/(login)<a name="get--api-v1-account-expire-(login)" class="headerlink" title="Permalink to this definition"></a> **GET /api/v1/account-expire/**<span class="sig-paren">(</span>*login*<span class="sig-paren">)</span><a name="get--api-v1-account-expire-(login)" class="headerlink" title="Permalink to this definition"></a>
Access to this service is restricted to just few source ipv4 addresses. Access to this service is restricted to just few source ipv4 addresses.
...@@ -142,7 +142,7 @@ Status Codes: ...@@ -142,7 +142,7 @@ Status Codes:
<!-- --> <!-- -->
### GET /api/v1/accounts-to-close/<span class="sig-paren">(</span>*category*<span class="sig-paren">)</span><a name="get--api-v1-accounts-to-close-(category)" class="headerlink" title="Permalink to this definition"></a> **GET /api/v1/accounts-to-close/**<span class="sig-paren">(</span>*category*<span class="sig-paren">)</span><a name="get--api-v1-accounts-to-close-(category)" class="headerlink" title="Permalink to this definition"></a>
Access to this service is restricted to just few source ipv4 addresses. Access to this service is restricted to just few source ipv4 addresses.
...@@ -196,7 +196,7 @@ Status Codes: ...@@ -196,7 +196,7 @@ Status Codes:
<!-- --> <!-- -->
### POST /api/v1/check-access<a name="post--api-v1-check-access" class="headerlink" title="Permalink to this definition"></a> **POST /api/v1/check-access**<a name="post--api-v1-check-access" class="headerlink" title="Permalink to this definition"></a>
A service to check if account and/or related project has the access to A service to check if account and/or related project has the access to
specified queue. specified queue.
...@@ -230,7 +230,7 @@ Status Codes: ...@@ -230,7 +230,7 @@ Status Codes:
<!-- --> <!-- -->
### GET /api/v1/dedicated-time/ <span class="sig-paren">(</span>*cluster\_type*<span class="sig-paren">)</span><a name="get--api-v1-dedicated-time-(cluster_type)" class="headerlink" title="Permalink to this definition"></a> **GET /api/v1/dedicated-time/**<span class="sig-paren">(</span>*cluster\_type*<span class="sig-paren">)</span><a name="get--api-v1-dedicated-time-(cluster_type)" class="headerlink" title="Permalink to this definition"></a>
Returns list of times dedicated for HPC maintainance. It is not possible Returns list of times dedicated for HPC maintainance. It is not possible
to use HPC services during maintainance. to use HPC services during maintainance.
...@@ -274,7 +274,7 @@ Status Codes: ...@@ -274,7 +274,7 @@ Status Codes:
<!-- --> <!-- -->
`GET /api/v1/graph_affiliation_stats`<a name="get--api-v1-graph_affiliation_stats" class="headerlink" title="Permalink to this definition"></a> **GET /api/v1/graph_affiliation_stats**<a name="get--api-v1-graph_affiliation_stats" class="headerlink" title="Permalink to this definition"></a>
Access to this service is restricted to just few source ipv4 addresses. Access to this service is restricted to just few source ipv4 addresses.
...@@ -361,7 +361,7 @@ Status Codes: ...@@ -361,7 +361,7 @@ Status Codes:
<!-- --> <!-- -->
`GET /api/v1/graph_research_area_stats`<a name="get--api-v1-graph_research_area_stats" class="headerlink" title="Permalink to this definition"></a> **GET /api/v1/graph_research_area_stats**<a name="get--api-v1-graph_research_area_stats" class="headerlink" title="Permalink to this definition"></a>
Access to this service is restricted to just few source ipv4 addresses. Access to this service is restricted to just few source ipv4 addresses.
...@@ -447,7 +447,7 @@ Status Codes: ...@@ -447,7 +447,7 @@ Status Codes:
<!-- --> <!-- -->
`GET /api/v1/graph_utilization_stats`<a name="get--api-v1-graph_utilization_stats" class="headerlink" title="Permalink to this definition"></a> **GET /api/v1/graph_utilization_stats**<a name="get--api-v1-graph_utilization_stats" class="headerlink" title="Permalink to this definition"></a>
Access to this service is restricted to just few source ipv4 addresses. Access to this service is restricted to just few source ipv4 addresses.
...@@ -595,7 +595,7 @@ Status Codes: ...@@ -595,7 +595,7 @@ Status Codes:
<!-- --> <!-- -->
`GET /api/v1/irregular-accounts-to-close`<a name="get--api-v1-irregular-accounts-to-close" class="headerlink" title="Permalink to this definition"></a> **GET /api/v1/irregular-accounts-to-close**<a name="get--api-v1-irregular-accounts-to-close" class="headerlink" title="Permalink to this definition"></a>
Access to this service is restricted to just few source ipv4 addresses. Access to this service is restricted to just few source ipv4 addresses.
...@@ -635,7 +635,7 @@ Status Codes: ...@@ -635,7 +635,7 @@ Status Codes:
<!-- --> <!-- -->
`POST /api/v1/it4ifree/`<span class="sig-paren">(</span>*login*<span class="sig-paren">)</span><a name="post--api-v1-it4ifree-(login)" class="headerlink" title="Permalink to this definition"></a> **POST /api/v1/it4ifree/**<span class="sig-paren">(</span>*login*<span class="sig-paren">)</span><a name="post--api-v1-it4ifree-(login)" class="headerlink" title="Permalink to this definition"></a>
A service to check resources of the projects on which the account A service to check resources of the projects on which the account
participate. If the calculation run on 1 cpu core during 1 hour, it participate. If the calculation run on 1 cpu core during 1 hour, it
...@@ -647,8 +647,8 @@ project resources. See ...@@ -647,8 +647,8 @@ project resources. See
for more details about so-called normalized core-hours. The json for more details about so-called normalized core-hours. The json
response contains two parts: response contains two parts:
- `me` – data from projects, where the account has access - **me** – data from projects, where the account has access
- `me_as_pi` – data from projects, where the account is PI (primary - **me_as_pi** – data from projects, where the account is PI (primary
investigator) investigator)
Request JSON Object: Request JSON Object:
...@@ -665,7 +665,7 @@ Response JSON Object: ...@@ -665,7 +665,7 @@ Response JSON Object:
- **login** (*string*) – account id - **login** (*string*) – account id
- **pid** (*string*) – project id - **pid** (*string*) – project id
- **pi\_login** (*string*) – account id which is PI - **pi\_login** (*string*) – account id which is PI
- **days\_left** (*string*) – days to the end of project, `---` if - **days\_left** (*string*) – days to the end of project, **---** if
project is inactive or not yet started project is inactive or not yet started
- **free** (*int*) – free core-hours which can be still consumed - **free** (*int*) – free core-hours which can be still consumed
- **total** (*int*) – total core-hours assigned to the project - **total** (*int*) – total core-hours assigned to the project
...@@ -741,7 +741,7 @@ Status Codes: ...@@ -741,7 +741,7 @@ Status Codes:
<!-- --> <!-- -->
`GET /api/v1/it4ifreetoken/`<span class="sig-paren">(</span>*login*<span class="sig-paren">)</span><a name="get--api-v1-it4ifreetoken-(login)" class="headerlink" title="Permalink to this definition"></a> **GET /api/v1/it4ifreetoken/**<span class="sig-paren">(</span>*login*<span class="sig-paren">)</span><a name="get--api-v1-it4ifreetoken-(login)" class="headerlink" title="Permalink to this definition"></a>
Access to this service is restricted to just few source ipv4 addresses. Access to this service is restricted to just few source ipv4 addresses.
...@@ -775,7 +775,7 @@ Status Codes: ...@@ -775,7 +775,7 @@ Status Codes:
<!-- --> <!-- -->
`GET /api/v1/motd/`<span class="sig-paren">(</span>*category*<span class="sig-paren">)</span><a name="get--api-v1-motd-(category)" class="headerlink" title="Permalink to this definition"></a> **GET /api/v1/motd/**<span class="sig-paren">(</span>*category*<span class="sig-paren">)</span><a name="get--api-v1-motd-(category)" class="headerlink" title="Permalink to this definition"></a>
Returns SCS messages of the day. Returns SCS messages of the day.
...@@ -825,7 +825,7 @@ Status Codes: ...@@ -825,7 +825,7 @@ Status Codes:
<!-- --> <!-- -->
`GET /api/v1/ping`<a name="get--api-v1-ping" class="headerlink" title="Permalink to this definition"></a> **GET /api/v1/ping**<a name="get--api-v1-ping" class="headerlink" title="Permalink to this definition"></a>
A service for testing connection to API. A service for testing connection to API.
...@@ -855,7 +855,7 @@ A service for testing connection to API. ...@@ -855,7 +855,7 @@ A service for testing connection to API.
<!-- --> <!-- -->
`GET /api/v1/quota-extra`<a name="get--api-v1-quota-extra" class="headerlink" title="Permalink to this definition"></a> **GET /api/v1/quota-extra**<a name="get--api-v1-quota-extra" class="headerlink" title="Permalink to this definition"></a>
Access to this service is restricted to just few source ipv4 addresses. Access to this service is restricted to just few source ipv4 addresses.
...@@ -905,7 +905,7 @@ Status Codes: ...@@ -905,7 +905,7 @@ Status Codes:
<!-- --> <!-- -->
`GET /api/v1/version`<a name="get--api-v1-version" class="headerlink" title="Permalink to this definition"></a> **GET /api/v1/version**<a name="get--api-v1-version" class="headerlink" title="Permalink to this definition"></a>
Returns basic information about API. Returns basic information about API.
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment