diff --git a/docs.it4i/apidocs.md b/docs.it4i/apidocs.md index 52e7a176695ea70668f441e65f46451a024b90ed..175d131eea51af5397ee018ad29f8bd8f39f48dc 100644 --- a/docs.it4i/apidocs.md +++ b/docs.it4i/apidocs.md @@ -1,4 +1,4 @@ -API Documentation +# API Documentation ============================================================================================================= Implements API for IT4I SCS Information System. @@ -7,7 +7,7 @@ Implements API for IT4I SCS Information System. - api version: `0.9-11-g9eb0678` - apidoc building date: `2017-12-11 15:00:03 +0100` -Summary +## Summary ------------------------------------------------------------------------------------- <table> @@ -97,10 +97,10 @@ Summary </tbody> </table> -API Details +## API Details --------------------------------------------------------------------------------------------- -GET /api/v1/account-expire/(login)<a name="get--api-v1-account-expire-(login)" class="headerlink" title="Permalink to this definition"></a> +### GET /api/v1/account-expire/(login)<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. @@ -142,7 +142,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> +### 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. @@ -196,7 +196,7 @@ Status Codes: <!-- --> - `POST /api/v1/check-access`<a name="post--api-v1-check-access" class="headerlink" title="Permalink to this definition"></a> +### 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. @@ -230,7 +230,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> +### 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.