summaryrefslogtreecommitdiffstats
path: root/admin/WebConsole/rest/opengnsys-api.yml
diff options
context:
space:
mode:
authorramon <ramongomez@us.es>2017-02-03 08:34:50 +0000
committerramon <ramongomez@us.es>2017-02-03 08:34:50 +0000
commit0126b05db2b7c8d08d56e7df83a4c304be66075c (patch)
tree27cdaa99c68dbbdc83269198c0cb8ba0311898f6 /admin/WebConsole/rest/opengnsys-api.yml
parent7766e7a3e6e5c147d33385eabae487e0bb7ef29f (diff)
#708: Corrección en mensajes JSON de algunas rutas REST para evitar confusión entre imagen de datos y foto de aula/ordenador; algunas correcciones en fichero de definición de la API REST.
git-svn-id: https://opengnsys.es/svn/branches/version1.1@5166 a21b9725-9963-47de-94b9-378ad31fedc9
Diffstat (limited to 'admin/WebConsole/rest/opengnsys-api.yml')
-rw-r--r--admin/WebConsole/rest/opengnsys-api.yml52
1 files changed, 42 insertions, 10 deletions
diff --git a/admin/WebConsole/rest/opengnsys-api.yml b/admin/WebConsole/rest/opengnsys-api.yml
index 19a2b555..0cd6c697 100644
--- a/admin/WebConsole/rest/opengnsys-api.yml
+++ b/admin/WebConsole/rest/opengnsys-api.yml
@@ -57,8 +57,18 @@ paths:
type: string
"400":
description: Missing parameters
+ schema:
+ type: object
+ properties:
+ message:
+ type: string
"500":
description: Authentication error
+ schema:
+ type: object
+ properties:
+ message:
+ type: string
tags:
- server
- user
@@ -378,7 +388,7 @@ paths:
description: Bittorrent connection extra time (in s.)
type: integer
format: int32
- image:
+ picture:
description: Lab's picture file
type: string
required: [ id, name, location, description, inremotepc, capacity, defclients, projector, board, routerip, netmask, mcastmode, mcastip, mcastport, mcastspeed, p2pmode, p2ptime, image ]
@@ -506,7 +516,7 @@ paths:
boottype:
description: boot template type
type: string
- image:
+ picture:
description: client's picture file
type: string
required: [ id, name, serialno, netiface, netdriver, mac, ip, netmask, routerip, repo, validation, image ]
@@ -738,12 +748,19 @@ paths:
responses:
"200":
description: Successful response
+ "400":
+ description: Error message
+ schema:
+ type: object
+ properties:
+ message:
+ type: string
security:
- apikey: []
tags:
- server
- client
- - uds
+ - remotepc
/ous/{ouid}/labs/{labid}/clients/{clientid}/session:
post:
description: Record session data for a client.
@@ -782,7 +799,7 @@ paths:
tags:
- server
- client
- - uds
+ - remotepc
/ous/{ouid}/labs/{labid}/clients/{clientid}/unreserve:
get:
description: Unreserve a client, clear its session data and send a poweroff operation.
@@ -810,7 +827,7 @@ paths:
tags:
- server
- client
- - uds
+ - remotepc
/ous/{ouid}/repos:
get:
description: Get all `repo` objects defined in an `OU`.
@@ -969,9 +986,6 @@ paths:
baseimg:
description: base image for an incremental image (if ``type`` is ``incremental``)
type: string
- path:
- description: image path (if ``type`` is ``incremental``)
- type: string
client:
description: model client's data
type: object
@@ -1084,13 +1098,31 @@ paths:
ip:
description: client IP address
type: string
- required: [ id, mac, ip ]
+ lab:
+ description: client's lab
+ type: object
+ properties:
+ id:
+ description: lab id
+ type: integer
+ format: int32
+ required: [ id ]
+ ou:
+ description: client's OU
+ type: object
+ properties:
+ id:
+ description: OU id
+ type: integer
+ format: int32
+ required: [ id ]
+ required: [ id, mac, ip, lab, ou ]
security:
- apikey: []
tags:
- server
- image
- - uds
+ - remotepc
/repository/images:
get:
description: Get information about images stored in a repository