diff --git a/docs.it4i/apidocs.md b/docs.it4i/apidocs.md index 6b1c71a9ae780b57e2dd7ee87d01cf646082c25a..e569bfde22407527bb4cebef379286f5f7b8ecfe 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:54:50 +0100` +- apidoc building date: `2017-12-11 14:58:50 +0100` Summary ------------------------------------------------------------------------------------- @@ -101,6 +101,7 @@ 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-(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 @@ -142,6 +143,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> + Access to this service is restricted to just few source ipv4 addresses. The standard account expires 365 days after the date when the last @@ -195,6 +197,7 @@ Status Codes: <!-- --> `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. @@ -228,6 +231,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> + Returns list of times dedicated for HPC maintainance. It is not possible to use HPC services during maintainance. @@ -271,6 +275,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> + 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 @@ -357,6 +362,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> + 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 @@ -442,6 +448,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> + Access to this service is restricted to just few source ipv4 addresses. It returns graph data to plot statistics of HPC week utilization during @@ -589,6 +596,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> + 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 @@ -628,6 +636,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> + 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 @@ -733,6 +742,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> + Access to this service is restricted to just few source ipv4 addresses. It returns free token for the account. @@ -766,6 +776,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> + Returns SCS messages of the day. Query Parameters: @@ -815,6 +826,7 @@ Status Codes: <!-- --> `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> @@ -844,6 +856,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> + Access to this service is restricted to just few source ipv4 addresses. Returns all accounts which have active filesystem quotas bigger than @@ -893,6 +906,7 @@ Status Codes: <!-- --> `GET /api/v1/version`<a name="get--api-v1-version" class="headerlink" title="Permalink to this definition"></a> + Returns basic information about API. <table>