Changes between Version 9 and Version 10 of ApiRest

Timestamp:

Feb 2, 2017, 2:28:09 PM (7 years ago)

Author:

ramon

Comment:

Reorganizar la página y crear secciones para documentar API REST de repositorio y agente.

ApiRest

@@ -13 +13 @@
 
 
-== Acceso autentificado a la API ==
-
-El acceso al API REST de OpenGnSys debe estar autentificado por una clave aleatoria que se asociada a aquellos usuarios con acceso al servidor.
-
-La aplicación que acceda al API REST debe usar una petición POST a una URL de conexión donde incluya los datos de usuario y clave y que devuelva la clave de acceso a la API. El resto de conexiones REST deberá usar una cabecera HTTP {{{Authentication}}} con el contenido de dicha clave.
-
-
-== Rutas de la API REST ==
-
-La API REST estará bajo la URL {{{https://}}}''{{{Servidor}}}''{{{/opengnsys/rest}}}. 
+== Generalidades de la API REST ==
 
 === Métodos HTTP en REST ===
@@ -35 +26 @@
 
 
+=== Acceso autentificado a la API ===
+
+El acceso al API REST de OpenGnSys debe estar autentificado por una clave aleatoria que se generará automáticamente a la hora de iniciar un servicio o se asociará a los usuarios con acceso al servidor.
+
+La aplicación que acceda al API REST debe usar una petición POST a una URL de conexión donde incluya los datos de usuario y clave y que devuelva la clave de acceso a la API. El resto de conexiones REST deberá usar una cabecera HTTP {{{Authentication}}} con el contenido de dicha clave.
+
+
 === Consultas REST ===
 
@@ -59 +57 @@
 
 
-=== Rutas definidas ===
+== Rutas definidas en OpenGnsys Server ==
+
+La API REST del servidor OpenGnsys estará bajo la URL {{{https://}}}''{{{Servidor}}}''{{{/opengnsys/rest}}}. 
 
 Nota: Las rutas que se indican son relativas a la URL de la API REST y los identificadores variables se preceden del carácter "{{{:}}}".
 
-==== Rutas generales ====
+=== Rutas generales ===
 
  - {{{/login}}}
@@ -83 +83 @@
      - {{{release}}} (cadena): revisión instalada.
      - {{{services}}} (array de cadenas): lista de servicios iniciados.
-     - {{{ous}}} (array de objetos): datos de los clientes ogLive instalados.
+     - {{{oglive}}} (array de objetos): datos de los clientes ogLive instalados.
        - {{{distribution}}} (cadena): distribución Linux del cliente ogLive.
        - {{{kernel}}} (cadena): versión del Kernel Linux.
@@ -280 +280 @@
      - Datos incluidos si la imagen es de tipo incremental:
        - {{{baseimg}}} (cadena): nombre de la imagen base.
-       - {{{path}}} (cadena): camino de la imagen.
      - Datos incluidos si la imagen ha sido generada en el cliente modelo:
        - {{{client}}} (objeto): datos del cliente modelo.
@@ -288 +287 @@
        - {{{creationdate}}} (cadena): fecha y hora de creación de la imagen (formato AAAA-MM-DD HH:MM:SS).
        - {{{release}}} (entero): nº de revisión de la imagen.
+     - Otros datos de interés (pueden ser ofrecidos por la API REST del repositorio):
+       - {{{filesize}}} (entero): tamaño del fichero de imagen creado (en KB).
+       - {{{fssize}}} (entero): tamaño mínimo del sistema de fichero donde alojar la imagen (en KB).
 
  - {{{/ous/:id1/images/:id2/software}}}
@@ -300 +302 @@
 
 
-==== Rutas para OGAgent ====
+=== Rutas para OGAgent ===
 
 Rutas que atienden las notificaciones ''push'' de agentes OGAgent:
@@ -338 +340 @@
 
 
-==== Rutas para Remote PC ====
+=== Rutas para Remote PC ===
 
 Las siguientes rutas REST serán utilizadas por un servidor UDS para controlar procesos de iniciación y parada de clientes que tengan instalada una imagen en particular. El servidor OpenGnsys actuará como intermediario entre el servidor de UDS y los agentes OGAgent instalados en los sistemas operativos que podrán usarse en remoto.
+
+ - {{{/ous/:id1/images/:id2/reserve}}} o {{{/ous/:id1/images/:id2/reserve?lab=:id3}}}
+   - Elegir al azar un cliente que tenga instalada una imagen (y, opcionalmente, que esté situado en una determinada aula), reservar su uso para acceso remoto y enviarle una operación de arranque en la partición de dicha imagen (o de reinicio, si el cliente está encendido).
+   - Método: GET.
+   - Parámetros:
+     - {{{lab}}} (intero): identificador del aula del cliente (opcional).
+   - Devuelve: objeto
+     - {{{id}}} (entero): identificador del cliente seleccionado.
+     - {{{mac}}} (cadena): dirección MAC de la interfaz de red (sin caracteres ":").
+     - {{{ip}}} (cadena): dirección IP del cliente.
+     - {{{ou}}} (objeto): OU a la que pertenecen.
+       - {{{id}}} (entero): identificador de la UO.
+     - {{{lab}}} (objeto): aula a la que pertenecen.
+       - {{{id}}} (entero): identificador de la UO.
+
+ - {{{/ous/:id1/images/:id2/events}}}
+   - Registrar URLs para redirigir a un servidor UDS aquellas notificaciones ''push'' enviadas por un agente OGAgent de un cliente reservado para acceso remoto.
+   - Método: POST.
+   - Parámetros:
+     - {{{urllogin}}} (cadena): URL para redirigir una notificación de inicio de sesión de usuario.
+     - {{{urllogout}}} (cadena): URL para redirigir una notificación de fin de sesión de usuario.
+
+ - {{{/ous/:id1/images/:id2/session}}}
+   - Registrar parámetros específicos de la sesión del usuario enviados por un servidor UDS.
+   - Método: POST.
+   - Parámetros:
+     - {{{poweroffAt}}} (cadena): hora para enviar una operación de apagado del cliente.
+
+ - {{{/ous/:id1/images/:id2/unreserve}}}
+   - Liberar un cliente marcado para acceso remoto, borrando sus datos de registro y enviando una operación de apagado.
+   - Método: GET.
 
 '''Notas de implementación:'''
@@ -349 +382 @@
  - Estudiar la manera de reintentar el envío de peticiones fallidas.
 
- - {{{/ous/:id1/images/:id2/reserve}}} o {{{/ous/:id1/images/:id2/reserve?lab=:id3}}}
-   - Elegir al azar un cliente que tenga instalada una imagen (y, opcionalmente, que esté situado en una determinada aula), reservar su uso para acceso remoto y enviarle una operación de arranque en la partición de dicha imagen (o de reinicio, si el cliente está encendido).
-   - Método: GET.
-   - Parámetros:
-     - {{{lab}}} (intero): identificador del aula del cliente (opcional).
-   - Devuelve: objeto
-     - {{{id}}} (entero): identificador del cliente seleccionado.
-     - {{{mac}}} (cadena): dirección MAC de la interfaz de red (sin caracteres ":").
-     - {{{ip}}} (cadena): dirección IP del cliente.
-     - {{{ou}}} (objeto): OU a la que pertenecen.
-       - {{{id}}} (entero): identificador de la UO.
-     - {{{lab}}} (objeto): aula a la que pertenecen.
-       - {{{id}}} (entero): identificador de la UO.
-
- - {{{/ous/:id1/images/:id2/events}}}
-   - Registrar URLs para redirigir a un servidor UDS aquellas notificaciones ''push'' enviadas por un agente OGAgent de un cliente reservado para acceso remoto.
-   - Método: POST.
-   - Parámetros:
-     - {{{urllogin}}} (cadena): URL para redirigir una notificación de inicio de sesión de usuario.
-     - {{{urllogout}}} (cadena): URL para redirigir una notificación de fin de sesión de usuario.
-
- - {{{/ous/:id1/images/:id2/session}}}
-   - Registrar parámetros específicos de la sesión del usuario enviados por un servidor UDS.
-   - Método: POST.
-   - Parámetros:
-     - {{{poweroffAt}}} (cadena): hora para enviar una operación de apagado del cliente.
-
- - {{{/ous/:id1/images/:id2/unreserve}}}
-   - Liberar un cliente marcado para acceso remoto, borrando sus datos de registro y enviando una operación de apagado.
-   - Método: GET.
-
+
+== Rutas definidas en OpenGnsys Repository ==
+
+La API REST de un repositorio OpenGnsys estará bajo la URL {{{https://}}}''{{{Repositorio}}}''{{{/opengnsys/rest}}}. 
+
+ - {{{/repository/images}}}
+   ''(documentar)''
+
+ - {{{/repository/poweron}}}
+   ''(documentar)''
+
+
+== Rutas definidas en OGAgent ==
+
+La API REST de un agente OpenGnsys para sistemas operativos estará bajo la URL {{{https://}}}''{{{Cliente}}}''{{{:8000/opengnsys}}}. 
+
+   ''(documentar)''