summaryrefslogtreecommitdiffstats
path: root/admin/WebConsole/rest/opengnsys-api.yml
diff options
context:
space:
mode:
authorramon <ramongomez@us.es>2016-09-29 12:39:31 +0000
committerramon <ramongomez@us.es>2016-09-29 12:39:31 +0000
commit72d37836f87142047f0c72be7bda1b77b7ec7bae (patch)
treeca29cac5a701cd1ed0982bb308dc8ca00bcb9577 /admin/WebConsole/rest/opengnsys-api.yml
parent208ee5055eccb8726ad78e1e52103a2a6fbfbdcc (diff)
#708: Continuar con la documentación de las rutas {{{POST /ogagent/...}}} de la API REST.
git-svn-id: https://opengnsys.es/svn/branches/version1.1@5021 a21b9725-9963-47de-94b9-378ad31fedc9
Diffstat (limited to 'admin/WebConsole/rest/opengnsys-api.yml')
-rw-r--r--admin/WebConsole/rest/opengnsys-api.yml112
1 files changed, 103 insertions, 9 deletions
diff --git a/admin/WebConsole/rest/opengnsys-api.yml b/admin/WebConsole/rest/opengnsys-api.yml
index 60a3fbd2..48ebf8db 100644
--- a/admin/WebConsole/rest/opengnsys-api.yml
+++ b/admin/WebConsole/rest/opengnsys-api.yml
@@ -1,9 +1,5 @@
-# Example YAML to get you started quickly.
-# Be aware that YAML has indentation based scoping.
-# Code completion support is available so start typing for available options.
swagger: '2.0'
-# This is your document metadata
info:
version: "1.1.0"
title: OpenGnsys REST API definition
@@ -13,7 +9,6 @@ info:
contact:
name: OpenGnsys Project
url: http://opengnsys.es/
- email: opengnsys-devel@listas.unizar.es
license:
name: Creative Commons 4.0 International
url: http://creativecommons.org/licenses/by/4.0/
@@ -773,7 +768,106 @@ paths:
#/ous/{ouid}/images/{imageid}/boot:
#/repository/images
#/repository/poweron
- #/ogagent/started
- #/ogagent/stopped
- #/ogagent/loggedin
- #/ogagent/loggedout
+ /ogagent/started:
+ post:
+ description: Process push notification when OGAgent is started
+ parameters:
+ - in: body
+ name: data
+ description: Operation data
+ required: true
+ schema:
+ type: object
+ properties:
+ ip:
+ type: string
+ mac:
+ type: string
+ ostype:
+ type: string
+ osversion:
+ type: string
+ secret:
+ type: string
+ responses:
+ "200":
+ description: Successful operation
+ "400":
+ description: An error has occurred
+ tags:
+ - server
+ - agent
+ /ogagent/stopped:
+ post:
+ description: Process push notification when OGAgent is stopped
+ parameters:
+ - in: body
+ name: data
+ description: Operation data
+ required: true
+ schema:
+ type: object
+ properties:
+ ip:
+ type: string
+ mac:
+ type: string
+ ostype:
+ type: string
+ osversion:
+ type: string
+ responses:
+ "200":
+ description: Successful operation
+ "400":
+ description: An error has occurred
+ tags:
+ - server
+ - agent
+ /ogagent/loggedin:
+ post:
+ description: Process push notification when an user logged in
+ parameters:
+ - in: body
+ name: data
+ description: Operation data
+ required: true
+ schema:
+ type: object
+ properties:
+ ip:
+ type: string
+ user:
+ type: string
+ responses:
+ "200":
+ description: Successful operation
+ "400":
+ description: An error has occurred
+ tags:
+ - server
+ - agent
+ /ogagent/loggedout:
+ post:
+ description: Process push notification when an user is logged in
+ parameters:
+ - in: body
+ name: data
+ description: Operation data
+ required: true
+ schema:
+ type: object
+ properties:
+ ip:
+ type: string
+ user:
+ type: string
+ responses:
+ "200":
+ description: Successful operation
+ "400":
+ description: An error has occurred
+ tags:
+ - server
+ - agent
+