diff --git a/docs.it4i/apidocs.md b/docs.it4i/apidocs.md index 175d131eea51af5397ee018ad29f8bd8f39f48dc..ffb928b2cc6bb6fc6f0c84684b47d8dd18f0012f 100644 --- a/docs.it4i/apidocs.md +++ b/docs.it4i/apidocs.md @@ -1,13 +1,13 @@ -# API Documentation +API Documentation ============================================================================================================= Implements API for IT4I SCS Information System. -- api revision: `9eb0678f / 2017-12-08 11:06:12 +0100` -- api version: `0.9-11-g9eb0678` -- apidoc building date: `2017-12-11 15:00:03 +0100` +- api revision: **9eb0678f / 2017-12-08 11:06:12 +0100** +- api version: **0.9-11-g9eb0678** +- apidoc building date: **2017-12-11 15:19:33 +0100** -## Summary +Summary ------------------------------------------------------------------------------------- <table> @@ -97,10 +97,10 @@ Implements API for IT4I SCS Information System. </tbody> </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. @@ -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. @@ -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 specified queue. @@ -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 to use HPC services during maintainance. @@ -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. @@ -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. @@ -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. @@ -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. @@ -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 participate. If the calculation run on 1 cpu core during 1 hour, it @@ -647,8 +647,8 @@ project resources. See for more details about so-called normalized core-hours. The json response contains two parts: -- `me` – data from projects, where the account has access -- `me_as_pi` – data from projects, where the account is PI (primary +- **me** – data from projects, where the account has access +- **me_as_pi** – data from projects, where the account is PI (primary investigator) Request JSON Object: @@ -665,7 +665,7 @@ Response JSON Object: - **login** (*string*) – account id - **pid** (*string*) – project id - **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 - **free** (*int*) – free core-hours which can be still consumed - **total** (*int*) – total core-hours assigned to the project @@ -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. @@ -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. @@ -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. @@ -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. @@ -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.