summaryrefslogtreecommitdiffstats
path: root/admin/WebConsole/rest/opengnsys-api.yml
diff options
context:
space:
mode:
authorramon <ramongomez@us.es>2016-11-11 13:42:22 +0000
committerramon <ramongomez@us.es>2016-11-11 13:42:22 +0000
commit23a72c068eb9c9344a7f058096f1af8c1b9faad9 (patch)
tree453bd9ddff70e0c9a31b6d5dfb81420610e88a53 /admin/WebConsole/rest/opengnsys-api.yml
parent26c54b632487395b7f89daf0a71dcee5d8e135aa (diff)
#761: Integrar rutas {{{/status}}} y {{{/ous/:ouid/groups}}} en version 1.1 y documentar ruta {{{/status}}}.
git-svn-id: https://opengnsys.es/svn/branches/version1.1@5088 a21b9725-9963-47de-94b9-378ad31fedc9
Diffstat (limited to 'admin/WebConsole/rest/opengnsys-api.yml')
-rw-r--r--admin/WebConsole/rest/opengnsys-api.yml56
1 files changed, 55 insertions, 1 deletions
diff --git a/admin/WebConsole/rest/opengnsys-api.yml b/admin/WebConsole/rest/opengnsys-api.yml
index 64f771e7..f14833d9 100644
--- a/admin/WebConsole/rest/opengnsys-api.yml
+++ b/admin/WebConsole/rest/opengnsys-api.yml
@@ -62,6 +62,23 @@ paths:
tags:
- server
- user
+ /status:
+ get:
+ description: Gets OpenGnsys Server status information
+ responses:
+ "200":
+ description: Successful response
+ schema:
+ type: object
+ properties:
+ memInfo:
+ description: Memory information
+ $ref: '#/definitions/meminfo'
+ cpu:
+ description: CPU information
+ $ref: '#/definitions/cpu'
+ tags:
+ - server
/ous:
get:
description: Gets all `OU` objects.
@@ -113,6 +130,25 @@ paths:
tags:
- server
- ou
+# /ous/{ouid}/groups:
+# get:
+# description: Get all group of labs defined in an `OU` object.
+# parameters:
+# - name: ouid
+# in: path
+# description: Organization Unit identificator
+# required: true
+# type: integer
+# responses:
+# "200":
+# description: Successful response
+# schema:
+# ...
+# security:
+# - apikey: []
+# tags:
+# - server
+# - ou
/ous/{ouid}/labs:
get:
description: Get all `lab` objects defined in an `OU`.
@@ -875,4 +911,22 @@ paths:
tags:
- server
- agent
-
+definitions:
+ meminfo:
+ properties:
+ total:
+ description: Total amount of memory
+ type: integer
+ format: int64
+ used:
+ description: Amount of used memory
+ type: integer
+ format: int64
+ cpu:
+ properties:
+ model:
+ description: Processor model
+ type: string
+ usage:
+ description: Average of processor load
+ type: float