Skip to content
Snippets Groups Projects
Commit fac5cd37 authored by Marek Chrastina's avatar Marek Chrastina
Browse files

Manual mdl fix fo test

parent c3ea8624
No related branches found
No related tags found
6 merge requests!368Update prace.md to document the change from qprace to qprod as the default...,!367Update prace.md to document the change from qprace to qprod as the default...,!366Update prace.md to document the change from qprace to qprod as the default...,!323extended-acls-storage-section,!196Master,!178Apidocs
Hide whitespace changes
Inline Side-by-side
Showing
with 19 additions and 19 deletions
docs.it4i/apidocs.md
+ 19
− 19
View file @ fac5cd37
......@@ -7,7 +7,7 @@
<div id="module-scs_api.server" class="section">
[]{#api-documentation}
API Documentation[](#module-scs_api.server "Permalink to this headline"){.headerlink}
API Documentation[](#module-scs_api.server "Permalink to this headline"){.headerlink}
======================================================================================
Implements API for IT4I SCS Information System.
......@@ -15,12 +15,12 @@ Implements API for IT4I SCS Information System.
- api revision: `9eb0678f / 2017-12-08 11:06:12 +0100`{.docutils
.literal}
- api version: `0.9-11-g9eb0678`{.docutils .literal}
- apidoc building date: `2017-12-08 15:52:11 +0100`{.docutils
- apidoc building date: `2017-12-08 16:05:36 +0100`{.docutils
.literal}
<div id="summary" class="section">
Summary[](#summary "Permalink to this headline"){.headerlink}
Summary[](#summary "Permalink to this headline"){.headerlink}
--------------------------------------------------------------
Resource Operation Description
......@@ -44,10 +44,10 @@ Summary[¶](#summary "Permalink to this headline"){.headerlink}
<div id="api-details" class="section">
API Details[](#api-details "Permalink to this headline"){.headerlink}
API Details[](#api-details "Permalink to this headline"){.headerlink}
----------------------------------------------------------------------
`GET `{.descname}`/api/v1/account-expire/`{.descname}[(]{.sig-paren}*login*[)]{.sig-paren}[](#get--api-v1-account-expire-(login) "Permalink to this definition"){.headerlink}
`GET `{.descname}`/api/v1/account-expire/`{.descname}[(]{.sig-paren}*login*[)]{.sig-paren}[](#get--api-v1-account-expire-(login) "Permalink to this definition"){.headerlink}
: Access to this service is restricted to just few source ipv4
addresses.
......@@ -113,7 +113,7 @@ API Details[¶](#api-details "Permalink to this headline"){.headerlink}
<!-- -->
`GET `{.descname}`/api/v1/accounts-to-close/`{.descname}[(]{.sig-paren}*category*[)]{.sig-paren}[](#get--api-v1-accounts-to-close-(category) "Permalink to this definition"){.headerlink}
`GET `{.descname}`/api/v1/accounts-to-close/`{.descname}[(]{.sig-paren}*category*[)]{.sig-paren}[](#get--api-v1-accounts-to-close-(category) "Permalink to this definition"){.headerlink}
: Access to this service is restricted to just few source ipv4
addresses.
......@@ -186,7 +186,7 @@ API Details[¶](#api-details "Permalink to this headline"){.headerlink}
<!-- -->
`POST `{.descname}`/api/v1/check-access`{.descname}[](#post--api-v1-check-access "Permalink to this definition"){.headerlink}
`POST `{.descname}`/api/v1/check-access`{.descname}[](#post--api-v1-check-access "Permalink to this definition"){.headerlink}
: A service to check if account and/or related project has the access
to specified queue.
......@@ -237,7 +237,7 @@ API Details[¶](#api-details "Permalink to this headline"){.headerlink}
<!-- -->
`GET `{.descname}`/api/v1/dedicated-time/`{.descname}[(]{.sig-paren}*cluster\_type*[)]{.sig-paren}[](#get--api-v1-dedicated-time-(cluster_type) "Permalink to this definition"){.headerlink}
`GET `{.descname}`/api/v1/dedicated-time/`{.descname}[(]{.sig-paren}*cluster\_type*[)]{.sig-paren}[](#get--api-v1-dedicated-time-(cluster_type) "Permalink to this definition"){.headerlink}
: Returns list of times dedicated for HPC maintainance. It is not
possible to use HPC services during maintainance.
......@@ -299,7 +299,7 @@ API Details[¶](#api-details "Permalink to this headline"){.headerlink}
<!-- -->
`GET `{.descname}`/api/v1/graph_affiliation_stats`{.descname}[](#get--api-v1-graph_affiliation_stats "Permalink to this definition"){.headerlink}
`GET `{.descname}`/api/v1/graph_affiliation_stats`{.descname}[](#get--api-v1-graph_affiliation_stats "Permalink to this definition"){.headerlink}
: Access to this service is restricted to just few source ipv4
addresses.
......@@ -405,7 +405,7 @@ API Details[¶](#api-details "Permalink to this headline"){.headerlink}
<!-- -->
`GET `{.descname}`/api/v1/graph_research_area_stats`{.descname}[](#get--api-v1-graph_research_area_stats "Permalink to this definition"){.headerlink}
`GET `{.descname}`/api/v1/graph_research_area_stats`{.descname}[](#get--api-v1-graph_research_area_stats "Permalink to this definition"){.headerlink}
: Access to this service is restricted to just few source ipv4
addresses.
......@@ -510,7 +510,7 @@ API Details[¶](#api-details "Permalink to this headline"){.headerlink}
<!-- -->
`GET `{.descname}`/api/v1/graph_utilization_stats`{.descname}[](#get--api-v1-graph_utilization_stats "Permalink to this definition"){.headerlink}
`GET `{.descname}`/api/v1/graph_utilization_stats`{.descname}[](#get--api-v1-graph_utilization_stats "Permalink to this definition"){.headerlink}
: Access to this service is restricted to just few source ipv4
addresses.
......@@ -677,7 +677,7 @@ API Details[¶](#api-details "Permalink to this headline"){.headerlink}
<!-- -->
`GET `{.descname}`/api/v1/irregular-accounts-to-close`{.descname}[](#get--api-v1-irregular-accounts-to-close "Permalink to this definition"){.headerlink}
`GET `{.descname}`/api/v1/irregular-accounts-to-close`{.descname}[](#get--api-v1-irregular-accounts-to-close "Permalink to this definition"){.headerlink}
: Access to this service is restricted to just few source ipv4
addresses.
......@@ -736,7 +736,7 @@ API Details[¶](#api-details "Permalink to this headline"){.headerlink}
<!-- -->
`POST `{.descname}`/api/v1/it4ifree/`{.descname}[(]{.sig-paren}*login*[)]{.sig-paren}[](#post--api-v1-it4ifree-(login) "Permalink to this definition"){.headerlink}
`POST `{.descname}`/api/v1/it4ifree/`{.descname}[(]{.sig-paren}*login*[)]{.sig-paren}[](#post--api-v1-it4ifree-(login) "Permalink to this definition"){.headerlink}
: 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
......@@ -866,7 +866,7 @@ API Details[¶](#api-details "Permalink to this headline"){.headerlink}
<!-- -->
`GET `{.descname}`/api/v1/it4ifreetoken/`{.descname}[(]{.sig-paren}*login*[)]{.sig-paren}[](#get--api-v1-it4ifreetoken-(login) "Permalink to this definition"){.headerlink}
`GET `{.descname}`/api/v1/it4ifreetoken/`{.descname}[(]{.sig-paren}*login*[)]{.sig-paren}[](#get--api-v1-it4ifreetoken-(login) "Permalink to this definition"){.headerlink}
: Access to this service is restricted to just few source ipv4
addresses.
......@@ -919,7 +919,7 @@ API Details[¶](#api-details "Permalink to this headline"){.headerlink}
<!-- -->
`GET `{.descname}`/api/v1/motd/`{.descname}[(]{.sig-paren}*category*[)]{.sig-paren}[](#get--api-v1-motd-(category) "Permalink to this definition"){.headerlink}
`GET `{.descname}`/api/v1/motd/`{.descname}[(]{.sig-paren}*category*[)]{.sig-paren}[](#get--api-v1-motd-(category) "Permalink to this definition"){.headerlink}
: Returns SCS messages of the day.
......@@ -987,12 +987,12 @@ API Details[¶](#api-details "Permalink to this headline"){.headerlink}
<!-- -->
`GET `{.descname}`/api/v1/ping`{.descname}[](#get--api-v1-ping "Permalink to this definition"){.headerlink}
`GET `{.descname}`/api/v1/ping`{.descname}[](#get--api-v1-ping "Permalink to this definition"){.headerlink}
: A service for testing connection to API.
--------------- -----------------------------------------------------------------------------------------------------------------
Status Codes: - [200 OK] http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html – no error
Status Codes: - [200 OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1){.reference .external} – no error
--------------- -----------------------------------------------------------------------------------------------------------------
**Example request**:
......@@ -1026,7 +1026,7 @@ API Details[¶](#api-details "Permalink to this headline"){.headerlink}
<!-- -->
`GET `{.descname}`/api/v1/quota-extra`{.descname}[](#get--api-v1-quota-extra "Permalink to this definition"){.headerlink}
`GET `{.descname}`/api/v1/quota-extra`{.descname}[](#get--api-v1-quota-extra "Permalink to this definition"){.headerlink}
: Access to this service is restricted to just few source ipv4
addresses.
......@@ -1095,7 +1095,7 @@ API Details[¶](#api-details "Permalink to this headline"){.headerlink}
<!-- -->
`GET `{.descname}`/api/v1/version`{.descname}[](#get--api-v1-version "Permalink to this definition"){.headerlink}
`GET `{.descname}`/api/v1/version`{.descname}[](#get--api-v1-version "Permalink to this definition"){.headerlink}
: Returns basic information about API.
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment