diff --git a/docs.it4i/apidocs.md b/docs.it4i/apidocs.md index 154d2289ef769d967e6b7c92b67af91742bf305f..6b1c71a9ae780b57e2dd7ee87d01cf646082c25a 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 14:10:29 +0100` +- apidoc building date: `2017-12-11 14:54:50 +0100` Summary ------------------------------------------------------------------------------------- @@ -26,7 +26,7 @@ Summary <tbody> <tr class="odd"> <td>account-expire</td> -<td><a href="#get--api-v1-account-expire">Link to Header</a>GET /api/v1/account-expire/(login)</td> +<td><a href="#get--api-v1-account-expire-(login)" class="reference external">GET /api/v1/account-expire/(login)</a></td> <td>Account expiration date</td> </tr> <tr class="even"> @@ -35,10 +35,9 @@ Summary <td>Standard accounts close to expiration date</td> </tr> <tr class="odd"> -<td>account-expire</td> -<td><a href="/apidocs#get--api-v1-account-expire">Link to Header</a>GET /api/v1/account-expire/(login)</td> -<td>Account expiration date</td> -</tr> +<td>check-access</td> +<td><a href="#post--api-v1-check-access" class="reference external">POST /api/v1/check-access</a></td> +<td>Access check to queue</td> </tr> <tr class="even"> <td>dedicated-time</td> @@ -101,8 +100,7 @@ Summary API Details --------------------------------------------------------------------------------------------- - `GET /api/v1/account-expire/`<span class="sig-paren">(</span>*login*<span class="sig-paren">)</span><a name="#get--api-v1-account-expire" 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. It returns the account expiration date. The account may participates on @@ -143,8 +141,7 @@ 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 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. The standard account expires 365 days after the date when the last @@ -197,8 +194,7 @@ 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 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. @@ -231,8 +227,7 @@ 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 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. @@ -275,8 +270,7 @@ 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 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. It returns graph data useful to plot statistics of using HPC by some @@ -362,8 +356,7 @@ 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 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. It returns graph data useful to plot statistics of using HPC by various @@ -448,8 +441,7 @@ 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 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. It returns graph data to plot statistics of HPC week utilization during @@ -596,8 +588,7 @@ 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 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. The special (e.g. training) account expires 31 days after the date when @@ -636,8 +627,7 @@ 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 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 consumes 1 core-hour from the project resources. However, some @@ -742,8 +732,7 @@ 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 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. It returns free token for the account. @@ -776,8 +765,7 @@ 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 name="get--api-v1-motd-(category)" class="headerlink" title="Permalink to this definition"></a> Returns SCS messages of the day. Query Parameters: @@ -826,8 +814,7 @@ 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 name="get--api-v1-ping" class="headerlink" title="Permalink to this definition"></a> A service for testing connection to API. <table> @@ -856,8 +843,7 @@ 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 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. Returns all accounts which have active filesystem quotas bigger than @@ -906,8 +892,7 @@ 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 name="get--api-v1-version" class="headerlink" title="Permalink to this definition"></a> Returns basic information about API. <table>