diff --git a/docs.it4i/apidocs.md b/docs.it4i/apidocs.md index f6213b2d0c4b697997ac6e8b612473a65e347167..235fc6601b7bd94d84ab33ee0f62a6a03607aee3 100644 --- a/docs.it4i/apidocs.md +++ b/docs.it4i/apidocs.md @@ -5,7 +5,7 @@ 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 13:18:07 +0100` +- apidoc building date: `2017-12-11 13:47:39 +0100` Summary ------------------------------------------------------------------------------------- @@ -26,7 +26,7 @@ Summary <tbody> <tr class="odd"> <td>account-expire</td> -<td><a href="#get--api-v1-account-expire-(login)" class="reference external">GET /api/v1/account-expire/(login)</a></td> +<td><a href="#get--api-v1-account-expire" class="reference external">GET /api/v1/account-expire/(login)</a></td> <td>Account expiration date</td> </tr> <tr class="even"> @@ -100,7 +100,8 @@ Summary API Details --------------------------------------------------------------------------------------------- - `GET /api/v1/account-expire/`<span class="sig-paren">(</span>*login*<span class="sig-paren">)</span><a href="#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 href="#get--api-v1-account-expire" class="headerlink" title="Permalink to this definition"></a> + Access to this service is restricted to just few source ipv4 addresses. It returns the account expiration date. The account may participates on @@ -141,7 +142,8 @@ Status Codes: <!-- --> - `GET /api/v1/accounts-to-close/`<span class="sig-paren">(</span>*category*<span class="sig-paren">)</span><a href="#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 href="#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. The standard account expires 365 days after the date when the last @@ -194,7 +196,8 @@ Status Codes: <!-- --> - `POST /api/v1/check-access`<a href="#post--api-v1-check-access" class="headerlink" Title="Permalink to this definition"></a> + `POST /api/v1/check-access`<a href="#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. @@ -227,7 +230,8 @@ Status Codes: <!-- --> - `GET /api/v1/dedicated-time/`<span class="sig-paren">(</span>*cluster\_type*<span class="sig-paren">)</span><a href="#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 href="#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. @@ -270,7 +274,8 @@ Status Codes: <!-- --> - `GET /api/v1/graph_affiliation_stats`<a href="#get--api-v1-graph_affiliation_stats" class="headerlink" Title="Permalink to this definition"></a> + `GET /api/v1/graph_affiliation_stats`<a href="#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. It returns graph data useful to plot statistics of using HPC by some @@ -356,7 +361,8 @@ Status Codes: <!-- --> - `GET /api/v1/graph_research_area_stats`<a href="#get--api-v1-graph_research_area_stats" class="headerlink" Title="Permalink to this definition"></a> + `GET /api/v1/graph_research_area_stats`<a href="#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. It returns graph data useful to plot statistics of using HPC by various @@ -441,7 +447,8 @@ Status Codes: <!-- --> - `GET /api/v1/graph_utilization_stats`<a href="#get--api-v1-graph_utilization_stats" class="headerlink" Title="Permalink to this definition"></a> + `GET /api/v1/graph_utilization_stats`<a href="#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. It returns graph data to plot statistics of HPC week utilization during @@ -588,7 +595,8 @@ Status Codes: <!-- --> - `GET /api/v1/irregular-accounts-to-close`<a href="#get--api-v1-irregular-accounts-to-close" class="headerlink" Title="Permalink to this definition"></a> + `GET /api/v1/irregular-accounts-to-close`<a href="#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. The special (e.g. training) account expires 31 days after the date when @@ -627,7 +635,8 @@ Status Codes: <!-- --> - `POST /api/v1/it4ifree/`<span class="sig-paren">(</span>*login*<span class="sig-paren">)</span><a href="#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 href="#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 consumes 1 core-hour from the project resources. However, some @@ -732,7 +741,8 @@ Status Codes: <!-- --> - `GET /api/v1/it4ifreetoken/`<span class="sig-paren">(</span>*login*<span class="sig-paren">)</span><a href="#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 href="#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. It returns free token for the account. @@ -765,7 +775,8 @@ Status Codes: <!-- --> - `GET /api/v1/motd/`<span class="sig-paren">(</span>*category*<span class="sig-paren">)</span><a href="#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 href="#get--api-v1-motd-(category)" class="headerlink" title="Permalink to this definition"></a> + Returns SCS messages of the day. Query Parameters: @@ -814,7 +825,8 @@ Status Codes: <!-- --> - `GET /api/v1/ping`<a href="#get--api-v1-ping" class="headerlink" Title="Permalink to this definition"></a> + `GET /api/v1/ping`<a href="#get--api-v1-ping" class="headerlink" title="Permalink to this definition"></a> + A service for testing connection to API. <table> @@ -843,7 +855,8 @@ A service for testing connection to API. <!-- --> - `GET /api/v1/quota-extra`<a href="#get--api-v1-quota-extra" class="headerlink" Title="Permalink to this definition"></a> + `GET /api/v1/quota-extra`<a href="#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. Returns all accounts which have active filesystem quotas bigger than @@ -892,7 +905,8 @@ Status Codes: <!-- --> - `GET /api/v1/version`<a href="#get--api-v1-version" class="headerlink" Title="Permalink to this definition"></a> + `GET /api/v1/version`<a href="#get--api-v1-version" class="headerlink" title="Permalink to this definition"></a> + Returns basic information about API. <table>