diff --git a/scs_api.server_public.md b/scs_api.server_public.md index 50e0a4237a00e7d4b1343ada399e45ed0f6e04fc..4ac85e7c3e5d9dc3af03c467ab98d5101e23249f 100644 --- a/scs_api.server_public.md +++ b/scs_api.server_public.md @@ -4,7 +4,7 @@ API Documentation Implements API for IT4I SCS Information System. -There is a PyPI package which provides a simple user-friendly shell +There is a PyPI package, which provides a simple user-friendly shell interface to call API requests and display their response. The package is available on <a href="https://pypi.org/project/it4i.portal.clients" class="uri reference external">https://pypi.org/project/it4i.portal.clients</a> @@ -15,11 +15,11 @@ is 6 requests per minute. Exceeding the limit will lead to your IP address being temporarily blocked from making further requests. The block will automatically be lifted by waiting an hour. -- api revision: `94e35984 / 2020-05-18 13:42:43 +0200` +- api revision: `67e60330 / 2020-05-19 09:58:15 +0200` -- api version: `0.9-243-g94e3598` +- api version: `0.9-245-g67e6033` -- apidoc building date: `2020-05-18 11:44:49 +0000` +- apidoc building date: `2020-05-19 08:00:21 +0000` Summary ------------------------------------------------------------------------------------- @@ -126,8 +126,8 @@ A service with a public dedicated time calendar. <a name="get--api-v1-dedicated-time-(cluster_type)" class="headerlink" title="Permalink to this definition"></a> **GET /api/v1/dedicated-time/**(cluster\_type) -Returns a list of times dedicated for HPC maintenance. It is not -possible to use HPC services during maintenance. +Returns a list of times dedicated for HPC maintenance. During +maintenance, HPC services are not available. Terminal implementation is available at <a href="https://pypi.org/project/it4i.portal.clients/#it4idedicatedtime" class="reference external">it4idedicatedtime</a> @@ -250,13 +250,13 @@ Status Codes **POST /api/v1/it4ifree/**(login) A service to check resources of the projects on which the account -participates. If the calculation runs on 1 cpu core for 1 hour, it +participates. If the calculation runs on 1 CPU core for 1 hour, it consumes 1 core-hour from the project’s resources. However, some calculations (or their placement) can be cheaper. Actual consumed -core-hours are reduced by a cheaping factor and then deducted from the +core-hours are reduced by a cheapening factor and then deducted from the project’s resources. See <a href="https://docs.it4i.cz/general/resources-allocation-policy/#normalized-core-hours-nch" class="reference external">link</a> -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: - `me` – data from projects, where the account has access