ogcore/APIs/web-core-ogboot.yaml

openapi: 3.0.3
info:
  title: Core - ogBoot - OpenAPI 3.0
  description: |-
    API for ogBOOT service. Used by OGweb.
    
    Some useful links:
    - [The ogBOOT repository](https://ognproject.evlt.uma.es/gitea/opengnsys/ogboot)    
  contact:
    name: ogn-qindel
    email: seguimiento-ogn-quindel@listas.unizar.es
  version: 1.0.0
paths:
  /opengnsys3/rest/core/clients:
    get:
      summary: Obtener Lista de Clientes
      description: Obtiene la lista de clientes registrados en el sistema.
      responses:
        '200':
          description: Lista de clientes
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Client'
        '401':
          description: No autorizado
  /opengnsys3/rest/core/wol:
    post:
      summary: Encender Equipos Remotamente (Wake-on-LAN)
      description: Envía comandos de encendido remoto a uno o varios equipos utilizando Wake-on-LAN.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WOLRequest'
      responses:
        '200':
          description: Comando de encendido enviado correctamente
        '401':
          description: No autorizado
  /opengnsys3/rest/core/session:
    post:
      summary: Gestión de Sesión
      description: Gestiona las sesiones de usuario en el sistema.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SessionRequest'
      responses:
        '200':
          description: Sesión gestionada correctamente
        '401':
          description: No autorizado
  /opengnsys3/rest/core/poweroff:
    post:
      summary: Apagar Equipos
      description: Envía comandos de apagado a uno o varios equipos.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PowerOffRequest'
      responses:
        '200':
          description: Comando de apagado enviado correctamente
        '401':
          description: No autorizado
  /opengnsys3/rest/core/reboot:
    post:
      summary: Reiniciar Equipos
      description: Envía comandos de reinicio a uno o varios equipos.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RebootRequest'
      responses:
        '200':
          description: Comando de reinicio enviado correctamente
        '401':
          description: No autorizado
  /opengnsys3/rest/core/stop:
    post:
      summary: Detener Operaciones en Curso
      description: Detiene las operaciones en curso en los equipos.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StopRequest'
      responses:
        '200':
          description: Operaciones detenidas correctamente
        '401':
          description: No autorizado
components:
  schemas:
    Client:
      type: object
      properties:
        id:
          type: integer
          description: ID del cliente
        name:
          type: string
          description: Nombre del cliente
        ip_address:
          type: string
          description: Dirección IP del cliente
        mac_address:
          type: string
          description: Dirección MAC del cliente
    WOLRequest:
      type: object
      properties:
        type:
          type: string
          description: Tipo de envío de paquetes Wake-on-LAN
        clients:
          type: array
          items:
            $ref: '#/components/schemas/Client'
    SessionRequest:
      type: object
      properties:
        clients:
          type: array
          items:
            type: string
            description: Direcciones IP de los clientes
        disk:
          type: string
          description: Número del disco duro
        partition:
          type: string
          description: Número de la partición
    PowerOffRequest:
      type: object
      properties:
        clients:
          type: array
          items:
            type: string
            description: Direcciones IP de los clientes
    RebootRequest:
      type: object
      properties:
        clients:
          type: array
          items:
            type: string
            description: Direcciones IP de los clientes
    StopRequest:
      type: object
      properties:
        clients:
          type: array
          items:
            type: string
            description: Direcciones IP de los clientes