Version Wed 13 May 2020 07:37:32 AM UTC

scs_api.server_public.md

@@ -4,22 +4,22 @@ API Documentation
 
 Implements API for IT4I SCS Information System.
 
-There is a PyPI package which provides simple user-friendly shell
-interface to call API requests and display their respond. Package is
-available on
+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>
 
-Limits are placed on the number of requests you may make to IT4I API.
-Rate limit can be changed without any warning at any time, but the
-default is 6 requests per minute. Exceeding the limit will lead to your
-ip address being temporarily blocked from making further requests. The
+The number of requests you may make to IT4I API is limited. The rate
+limit can be changed without prior notice at any time, but the default
+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: `5eaacb6a / 2020-05-12 10:49:05 +0200`
+- api revision: `b9c85152 / 2020-05-13 09:34:45 +0200`
 
-- api version: `0.9-233-g5eaacb6`
+- api version: `0.9-235-gb9c8515`
 
-- apidoc building date: `2020-05-12 08:51:21 +0000`
+- apidoc building date: `2020-05-13 07:36:53 +0000`
 
 Summary
 -------------------------------------------------------------------------------------
@@ -87,8 +87,8 @@ API Details
 <a name="post--api-v1-check-access" class="headerlink" title="Permalink to this definition"></a>
  **POST /api/v1/check-access**
 
-A service to check if account and/or related project has the access to
-specified queue.
+A service to check if an account and/or related project has an access to
+a specified queue.
 
 Terminal implementation is available at
 <a href="https://pypi.org/project/it4i.portal.clients/#it4icheckaccess" class="reference external">it4icheckaccess</a>
@@ -98,7 +98,7 @@ Request JSON Object
 
 - **queue** (*string*) – queue id
 
-- **pid** (*string*) – project id, not required if querying
+- **pid** (*string*) – project id, not required if querying a
     projectless queue
 
 Status Codes
@@ -121,13 +121,13 @@ Status Codes
 <a name="get--api-v1-dedicated-time-calendar" class="headerlink" title="Permalink to this definition"></a>
  **GET /api/v1/dedicated-time-calendar**
 
-A service with public dedicated time calendar.
+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 list of times dedicated for HPC maintainance. It is not possible
-to use HPC services during maintainance.
+Returns a list of times dedicated for HPC maintenance. It is not
+possible to use HPC services during maintenance.
 
 Terminal implementation is available at
 <a href="https://pypi.org/project/it4i.portal.clients/#it4idedicatedtime" class="reference external">it4idedicatedtime</a>
@@ -135,13 +135,13 @@ Terminal implementation is available at
 Query Parameters
 - **all** – returns all dedicated times for all clusters
 
-- **salomon** – returns all times just for salomon cluster
+- **salomon** – returns all times just for the Salomon cluster
 
-- **anselm** – returns all times just for anselm cluster
+- **anselm** – returns all times just for the Anselm cluster
 
-- **barbora** – returns all times just for barbora cluster
+- **barbora** – returns all times just for the Barbora cluster
 
-- **dgx** – returns all times just for dgx cluster
+- **dgx** – returns all times just for the DGX cluster
 
 - **active** – returns dedicated times for all clusters which are now
     active
@@ -224,11 +224,11 @@ Status Codes
  **POST /api/v1/it4ifree/**(login)
 
 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
+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 deduct from the
-project resources. See
+core-hours are reduced by a cheaping 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
 response contains two parts:
@@ -259,7 +259,7 @@ Response JSON Object
 - **days\_left** (*string*) – days to the end of project, or inactive,
     expired, forthcoming, upcoming, unlimited
 
-- **free** (*int*) – free core-hours which can be still consumed
+- **free** (*int*) – free core-hours which can still be consumed
 
 - **total** (*int*) – total core-hours assigned to the project
 
@@ -434,9 +434,9 @@ Returns basic information about API.
 Response JSON Object
 - **hostname** (*string*) – system hostname
 
-- **revision** (*string*) – api revision / build time
+- **revision** (*string*) – API revision / build time
 
-- **version** (*string*) – api version
+- **version** (*string*) – API version
 
 Status Codes
 - <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1" class="reference external">200 OK</a>