diff --git a/docs.it4i/apidocs.md b/docs.it4i/apidocs.md
index 141eae58d3096f81aa8ee530f530fdfa40deecdb..65a2df5a4cf0d81c592ccdb31a7ce9ff0eecf491 100644
--- a/docs.it4i/apidocs.md
+++ b/docs.it4i/apidocs.md
@@ -1,18 +1,14 @@
-
-
-
-
API Documentation_public
=============================================================================================
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-08 15:01:48 +0100`
-
+- api revision: `9eb0678f / 2017-12-08 11:06:12 +0100`
+- api version: `0.9-11-g9eb0678`
+- apidoc building date: `2017-12-08 15:01:48 +0100`
Summary
+
--------------------------------------------------------------
Resource | Operation | Description
------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------| ----------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
@@ -28,85 +24,63 @@ API Details
`POST /api/v1/check-access` {#post--api-v1-check-access}
-: A service to check if account and/or related project has the access
+ : A service to check if account and/or related project has the access
to specified queue.
Request JSON Object:
-
-
- - **login** (*string*) – account id
- - **queue** (*string*) – queue id
- - **pid** (*string*) – project id, not required if querying
- projectless queue
+ - **login** (*string*) – account id
+ - **queue** (*string*) – queue id
+ - **pid** (*string*) – project id, not required if querying projectless queue
Status Codes:
- - [200
- OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1)
+ - [200 OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1)
– no error
**Example request**:
-
-
curl -i -H "Content-Type:application/json" -X POST \
--data '{"pid":"DD-13-5","login":"johnsm","queue":"qfat"}' \
https://scs.it4i.cz/api/v1/check-access
-
-
**Example response**:
-
-
HTTP/1.1 200 OK
Content-Type: application/json
"OK Access granted for regular queue."
-
-
-<!-- -->
-
`GET /api/v1/dedicated-time/`(*cluster\_type*) {#get--api-v1-dedicated-time-cluster_type}
-: Returns list of times dedicated for HPC maintainance. It is not
+ : Returns list of times dedicated for HPC maintainance. It is not
possible to use HPC services during maintainance.
Query Parameters:
-
-
- - **all** – returns all dedicated times for all clusters
- - **salomon** – returns all times just for salomon cluster
- - **anselm** – returns all times just for anselm cluster
- - **active** – returns dedicated times for all clusters which are
+ - **all** – returns all dedicated times for all clusters
+ - **salomon** – returns all times just for salomon cluster
+ - **anselm** – returns all times just for anselm cluster
+ - **active** – returns dedicated times for all clusters which are
now active
- - **planned** – returns dedicated times for all clusters which are
+ - **planned** – returns dedicated times for all clusters which are
now active or scheduled in the future
Status Codes:
- - [200
+ - [200
OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1)
– no error
- - [405 Method Not
+ - [405 Method Not
Allowed](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6)
– invalid requested query parameter
**Example request**:
-
-
curl -i curl https://scs.it4i.cz/api/v1/dedicated-time/all
-
-
**Example response**:
-
-
HTTP/1.1 200 OK
Content-Type: application/json
@@ -119,13 +93,9 @@ API Details
}
]
-
-
-<!-- -->
-
`POST /api/v1/it4ifree/`(*login*) {#post--api-v1-it4ifree-login}
-: A service to check resources of the projects on which the account
+ : 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
calculations (or their placement) can be cheaper. Actual consumed
@@ -135,64 +105,50 @@ API Details
for more details about so-called normalized core-hours. The json
response contains two parts:
- >
- > - `me` – data from projects, where the
- > account has access
- > - `me_as_pi` – data from projects, where the
- > account is PI (primary investigator)
- >
+ - `me` – data from projects, where the account has access
+ - `me_as_pi` – data from projects, where the account is PI (primary investigator)
Request JSON Object:
-
-
- - **login** (*string*) – account id
- - **it4ifreetoken** (*string*) – token
+ - **login** (*string*) – account id
+ - **it4ifreetoken** (*string*) – token
Response JSON Object:
-
-
- - **login** (*string*) – account id
- - **pid** (*string*) – project id
- - **pi\_login** (*string*) – account id which is PI
- - **days\_left** (*string*) – days to the end of project,
+ - **login** (*string*) – account id
+ - **pid** (*string*) – project id
+ - **pi\_login** (*string*) – account id which is PI
+ - **days\_left** (*string*) – days to the end of project,
`---` if project is inactive or not yet
started
- - **free** (*int*) – free core-hours which can be still consumed
- - **total** (*int*) – total core-hours assigned to the project
- - **used** (*int*) – actual consumed core-hours
- - **used\_with\_factor** (*int*) – consumed normalized core-hours
- - **used\_by\_me** (*int*) – core-hours consumed by the account
- - **used\_by\_me\_with\_factor** (*int*) – normalized core-hours
+ - **free** (*int*) – free core-hours which can be still consumed
+ - **total** (*int*) – total core-hours assigned to the project
+ - **used** (*int*) – actual consumed core-hours
+ - **used\_with\_factor** (*int*) – consumed normalized core-hours
+ - **used\_by\_me** (*int*) – core-hours consumed by the account
+ - **used\_by\_me\_with\_factor** (*int*) – normalized core-hours
consumed by the account
- - **corehours** (*int*) – core-hours consumed by the account
- - **core\_hours\_with\_factor** (*int*) – normalized core-hours
+ - **corehours** (*int*) – core-hours consumed by the account
+ - **core\_hours\_with\_factor** (*int*) – normalized core-hours
consumed by the account
Status Codes:
- - [200
+ - [200
OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1)
– no error
- - [405 Method Not
+ - [405 Method Not
Allowed](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6)
– token does not match
**Example request**:
-
-
curl -i -H "Content-Type:application/json" -X POST \
--data '{"login":"johnsm", "it4ifreetoken": "abc"}' \
https://scs.it4i.cz/api/v1/it4ifree/johnsm
-
-
**Example response**:
-
-
HTTP/1.1 200 OK
Content-Type: application/json
@@ -239,43 +195,31 @@ API Details
]
}
-
-
-<!-- -->
-
`GET /api/v1/motd/`(*category*) {#get--api-v1-motd-category}
-: Returns SCS messages of the day.
+ : Returns SCS messages of the day.
Query Parameters:
-
-
- - **notice** – returns only notice messages
- - **important** – returns only important messages
- - **all** – returns all messages
+ - **notice** – returns only notice messages
+ - **important** – returns only important messages
+ - **all** – returns all messages
Status Codes:
- - [200
+ - [200
OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1)
– no error
- - [405 Method Not
+ - [405 Method Not
Allowed](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6)
– invalid requested query parameter
**Example request**:
-
-
curl -i https://scs.it4i.cz/api/v1/motd/notice
-
-
**Example response**:
-
-
HTTP/1.1 200 OK
Content-Type: application/json
@@ -299,30 +243,19 @@ API Details
}
]
-
-
-<!-- -->
-
`GET /api/v1/ping` {#get--api-v1-ping}
-: A service for testing connection to API.
+ : A service for testing connection to API.
- --------------- -----------------------------------------------------------------------------------------------------------------
- Status Codes: - [200 OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1) – no error
- --------------- -----------------------------------------------------------------------------------------------------------------
+ Status Codes:
+ - [200 OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1) – no error
**Example request**:
-
-
curl -i https://scs.it4i.cz/api/v1/ping
-
-
**Example response**:
-
-
HTTP/1.1 200 OK
Content-Type: application/json
@@ -330,30 +263,20 @@ API Details
"message": "pong"
}
-
-
-<!-- -->
-
`GET /api/v1/version` {#get--api-v1-version}
-: Returns basic information about API.
+ : Returns basic information about API.
- --------------- -----------------------------------------------------------------------------------------------------------------
- Status Codes: - [200 OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1) – no error
- --------------- -----------------------------------------------------------------------------------------------------------------
-
- **Example request**:
+ Status Codes:
+ - [200 OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1) – no error
+ **Example request**:
curl -i https://scs.it4i.cz/api/v1/version
-
-
**Example response**:
-
-
HTTP/1.1 200 OK
Content-Type: application/json
@@ -363,17 +286,6 @@ API Details
"version": "0.8.2-34-gceac8aa"
}
-
-
-
-
-
-
-
-
-
-
©2017, IT4Innovations. | Powered by [Sphinx
1.5.6](http://sphinx-doc.org/) & [Alabaster
0.7.10](https://github.com/bitprophet/alabaster)
-