From 78c160274b4968ea4e12530aa38a5c1ff928d73a Mon Sep 17 00:00:00 2001 From: apuente Date: Wed, 15 May 2024 14:38:29 +0200 Subject: [PATCH 1/7] Add Ogdhcp y Ogboot apis definitions --- APIs/web-core-ogboot.yaml | 2 +- APIs/web-core-ogdhcp.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/APIs/web-core-ogboot.yaml b/APIs/web-core-ogboot.yaml index 7c9ca90..54ae2be 100644 --- a/APIs/web-core-ogboot.yaml +++ b/APIs/web-core-ogboot.yaml @@ -165,4 +165,4 @@ components: type: array items: type: string - description: Direcciones IP de los clientes + description: Direcciones IP de los clientes \ No newline at end of file diff --git a/APIs/web-core-ogdhcp.yaml b/APIs/web-core-ogdhcp.yaml index d686881..c3f3e14 100644 --- a/APIs/web-core-ogdhcp.yaml +++ b/APIs/web-core-ogdhcp.yaml @@ -343,4 +343,4 @@ components: address: type: string example: 172.30.4.11 - type: object + type: object \ No newline at end of file -- 2.40.1 From 4a45cfea36592b185203a4d48fcf1cfdcddaaae9 Mon Sep 17 00:00:00 2001 From: Alvaro Puente Mella Date: Wed, 15 May 2024 15:07:20 +0200 Subject: [PATCH 2/7] Delete files for initial PR fix --- APIs/web-core-ogboot.yaml | 168 -------------------------------------- 1 file changed, 168 deletions(-) delete mode 100644 APIs/web-core-ogboot.yaml diff --git a/APIs/web-core-ogboot.yaml b/APIs/web-core-ogboot.yaml deleted file mode 100644 index 54ae2be..0000000 --- a/APIs/web-core-ogboot.yaml +++ /dev/null @@ -1,168 +0,0 @@ -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 \ No newline at end of file -- 2.40.1 From 6721b04223dbe277eb1091754588bdb995fa8cbd Mon Sep 17 00:00:00 2001 From: Alvaro Puente Mella Date: Wed, 15 May 2024 15:07:28 +0200 Subject: [PATCH 3/7] Delete files for initial PR fix --- APIs/web-core-ogdhcp.yaml | 346 -------------------------------------- 1 file changed, 346 deletions(-) delete mode 100644 APIs/web-core-ogdhcp.yaml diff --git a/APIs/web-core-ogdhcp.yaml b/APIs/web-core-ogdhcp.yaml deleted file mode 100644 index c3f3e14..0000000 --- a/APIs/web-core-ogdhcp.yaml +++ /dev/null @@ -1,346 +0,0 @@ -openapi: 3.0.3 -info: - title: Core - ogDHCP - OpenAPI 3.0 - description: |- - API for DHCP service. Used by OGweb. - - Some useful links: - - [The ogDHCP repository](https://ognproject.evlt.uma.es/gitea/opengnsys/ogdhcp) - contact: - name: ogn-qindel - email: seguimiento-ogn-quindel@listas.unizar.es - version: 1.0.0 -paths: - /opengnsys3/rest/core/subnets: - get: - operationId: 8f92a1cbcb8cd176bdc4ae272b3ad303 - responses: - '200': - description: Devuelve todas las subredes - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/Subnet' - '400': - description: Error al obtener las subredes - post: - summary: Add a new DHCP subnet - operationId: 88949bae5e7784ce2721ffafe7c88c0a - requestBody: - description: JSON payload - required: true - content: - application/json: - schema: - properties: - subnetId: - type: integer - example: 2 - mask: - type: string - example: 255.255.255.0 - address: - type: string - example: 192.168.1.0 - nextServer: - type: string - example: 192.168.1.1 - bootFileName: - type: string - example: pxelinux.0 - type: object - responses: - '200': - description: Subnet added successfully - content: - application/json: - schema: - properties: - success: - type: string - type: object - '400': - description: Error occurred - content: - application/json: - schema: - properties: - error: - type: string - type: object - /opengnsys3/rest/core/subnets/{subnetId}: - put: - summary: Modify a DHCP subnet - operationId: 548b55fc0e1ad59ea5b5c909dfd07c71 - parameters: - - name: subnetId - in: path - description: ID of the subnet to modify - required: true - schema: - type: integer - requestBody: - description: Data to modify the subnet - required: true - content: - application/json: - schema: - properties: - mask: - type: string - address: - type: string - nextServer: - type: string - bootFileName: - type: string - type: object - responses: - '200': - description: Subnet modified successfully - content: - application/json: - schema: - properties: - success: - type: string - type: object - '400': - description: Error occurred - content: - application/json: - schema: - properties: - error: - type: string - type: object - delete: - summary: Delete a DHCP subnet - operationId: c1c1c34729bdd85857b22e6e2bdc41de - parameters: - - name: subnetId - in: path - description: ID of the subnet to delete - required: true - schema: - type: integer - responses: - '200': - description: Subnet deleted successfully - content: - application/json: - schema: - properties: - success: - type: string - type: object - '400': - description: Error occurred - content: - application/json: - schema: - properties: - error: - type: string - type: object - /opengnsys3/rest/core/subnets/{subnetId}/hosts: - get: - summary: Get all hosts in a subnet - operationId: 0989ca622a6a7e23f5af8e3bdd6f6b05 - parameters: - - name: subnetId - in: path - description: The ID of the subnet - required: true - schema: - type: integer - responses: - '200': - description: List of hosts in the subnet - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/Host' - '400': - description: Error occurred - content: - application/json: - schema: - properties: - error: - type: string - type: object - '500': - description: Server error - content: - application/json: - schema: - properties: - error: - type: string - type: object - put: - summary: Update a DHCP host - operationId: 1541441cd53685aaf6df45ab48befaa8 - parameters: - - name: subnetId - in: path - description: The ID of the subnet - required: true - schema: - type: integer - requestBody: - description: Data for the host to update - required: true - content: - application/json: - schema: - properties: - host: - type: string - example: pc11 - oldMacAddress: - type: string - example: 56:6f:c7:4f:00:4f - oldAddress: - type: string - example: 192.168.1.11 - macAddress: - type: string - example: 56:6f:c7:4f:01:01 - address: - type: string - example: 192.168.1.11 - type: object - responses: - '200': - description: Host updated successfully - content: - application/json: - schema: - properties: - success: - type: string - type: object - '400': - description: Error occurred - content: - application/json: - schema: - properties: - error: - type: string - type: object - post: - summary: Add a DHCP host to a subnet - operationId: 3f897dcd7c04787ac9c42ddbb57cb800 - parameters: - - name: subnetId - in: path - description: ID of the subnet to add the host to - required: true - schema: - type: integer - requestBody: - description: Data for the new host - required: true - content: - application/json: - schema: - properties: - host: - type: string - example: pc11 - macAddress: - type: string - example: 56:6f:c7:4f:00:4f - address: - type: string - example: 172.30.4.11 - type: object - responses: - '200': - description: Host added successfully - content: - application/json: - schema: - properties: - success: - type: string - type: object - '400': - description: Error occurred - content: - application/json: - schema: - properties: - error: - type: string - type: object - delete: - summary: Delete a DHCP host from a specific subnet - operationId: f652c52b39d57d283401df66a7930b5f - parameters: - - name: subnetId - in: path - description: The ID of the subnet - required: true - schema: - type: integer - responses: - '200': - description: Host deleted successfully - content: - application/json: - schema: - properties: - success: - type: string - type: object - '400': - description: Error occurred - content: - application/json: - schema: - properties: - error: - type: string - type: object -components: - schemas: - Subnet: - properties: - id: - description: The ID of the subnet - type: integer - subnet: - description: The name of the subnet - type: string - next-server: - description: The next server in the subnet - type: string - boot-file-name: - description: The boot file name for the subnet - type: string - reservations: - type: array - items: - description: The reservations in the subnet - type: object - type: object - Host: - properties: - host: - type: string - example: pc11 - macAddress: - type: string - example: 56:6f:c7:4f:00:4f - address: - type: string - example: 172.30.4.11 - type: object \ No newline at end of file -- 2.40.1 From 89e41134b456937a1847afd091bc3bf16cc446bb Mon Sep 17 00:00:00 2001 From: apuente Date: Wed, 15 May 2024 15:08:29 +0200 Subject: [PATCH 4/7] Add Ogdhcp y Ogboot apis definitions --- APIs/web-core-ogboot.yaml | 168 ++++++++++++++++++ APIs/web-core-ogdhcp.yaml | 346 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 514 insertions(+) create mode 100644 APIs/web-core-ogboot.yaml create mode 100644 APIs/web-core-ogdhcp.yaml diff --git a/APIs/web-core-ogboot.yaml b/APIs/web-core-ogboot.yaml new file mode 100644 index 0000000..54ae2be --- /dev/null +++ b/APIs/web-core-ogboot.yaml @@ -0,0 +1,168 @@ +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 \ No newline at end of file diff --git a/APIs/web-core-ogdhcp.yaml b/APIs/web-core-ogdhcp.yaml new file mode 100644 index 0000000..c3f3e14 --- /dev/null +++ b/APIs/web-core-ogdhcp.yaml @@ -0,0 +1,346 @@ +openapi: 3.0.3 +info: + title: Core - ogDHCP - OpenAPI 3.0 + description: |- + API for DHCP service. Used by OGweb. + + Some useful links: + - [The ogDHCP repository](https://ognproject.evlt.uma.es/gitea/opengnsys/ogdhcp) + contact: + name: ogn-qindel + email: seguimiento-ogn-quindel@listas.unizar.es + version: 1.0.0 +paths: + /opengnsys3/rest/core/subnets: + get: + operationId: 8f92a1cbcb8cd176bdc4ae272b3ad303 + responses: + '200': + description: Devuelve todas las subredes + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Subnet' + '400': + description: Error al obtener las subredes + post: + summary: Add a new DHCP subnet + operationId: 88949bae5e7784ce2721ffafe7c88c0a + requestBody: + description: JSON payload + required: true + content: + application/json: + schema: + properties: + subnetId: + type: integer + example: 2 + mask: + type: string + example: 255.255.255.0 + address: + type: string + example: 192.168.1.0 + nextServer: + type: string + example: 192.168.1.1 + bootFileName: + type: string + example: pxelinux.0 + type: object + responses: + '200': + description: Subnet added successfully + content: + application/json: + schema: + properties: + success: + type: string + type: object + '400': + description: Error occurred + content: + application/json: + schema: + properties: + error: + type: string + type: object + /opengnsys3/rest/core/subnets/{subnetId}: + put: + summary: Modify a DHCP subnet + operationId: 548b55fc0e1ad59ea5b5c909dfd07c71 + parameters: + - name: subnetId + in: path + description: ID of the subnet to modify + required: true + schema: + type: integer + requestBody: + description: Data to modify the subnet + required: true + content: + application/json: + schema: + properties: + mask: + type: string + address: + type: string + nextServer: + type: string + bootFileName: + type: string + type: object + responses: + '200': + description: Subnet modified successfully + content: + application/json: + schema: + properties: + success: + type: string + type: object + '400': + description: Error occurred + content: + application/json: + schema: + properties: + error: + type: string + type: object + delete: + summary: Delete a DHCP subnet + operationId: c1c1c34729bdd85857b22e6e2bdc41de + parameters: + - name: subnetId + in: path + description: ID of the subnet to delete + required: true + schema: + type: integer + responses: + '200': + description: Subnet deleted successfully + content: + application/json: + schema: + properties: + success: + type: string + type: object + '400': + description: Error occurred + content: + application/json: + schema: + properties: + error: + type: string + type: object + /opengnsys3/rest/core/subnets/{subnetId}/hosts: + get: + summary: Get all hosts in a subnet + operationId: 0989ca622a6a7e23f5af8e3bdd6f6b05 + parameters: + - name: subnetId + in: path + description: The ID of the subnet + required: true + schema: + type: integer + responses: + '200': + description: List of hosts in the subnet + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Host' + '400': + description: Error occurred + content: + application/json: + schema: + properties: + error: + type: string + type: object + '500': + description: Server error + content: + application/json: + schema: + properties: + error: + type: string + type: object + put: + summary: Update a DHCP host + operationId: 1541441cd53685aaf6df45ab48befaa8 + parameters: + - name: subnetId + in: path + description: The ID of the subnet + required: true + schema: + type: integer + requestBody: + description: Data for the host to update + required: true + content: + application/json: + schema: + properties: + host: + type: string + example: pc11 + oldMacAddress: + type: string + example: 56:6f:c7:4f:00:4f + oldAddress: + type: string + example: 192.168.1.11 + macAddress: + type: string + example: 56:6f:c7:4f:01:01 + address: + type: string + example: 192.168.1.11 + type: object + responses: + '200': + description: Host updated successfully + content: + application/json: + schema: + properties: + success: + type: string + type: object + '400': + description: Error occurred + content: + application/json: + schema: + properties: + error: + type: string + type: object + post: + summary: Add a DHCP host to a subnet + operationId: 3f897dcd7c04787ac9c42ddbb57cb800 + parameters: + - name: subnetId + in: path + description: ID of the subnet to add the host to + required: true + schema: + type: integer + requestBody: + description: Data for the new host + required: true + content: + application/json: + schema: + properties: + host: + type: string + example: pc11 + macAddress: + type: string + example: 56:6f:c7:4f:00:4f + address: + type: string + example: 172.30.4.11 + type: object + responses: + '200': + description: Host added successfully + content: + application/json: + schema: + properties: + success: + type: string + type: object + '400': + description: Error occurred + content: + application/json: + schema: + properties: + error: + type: string + type: object + delete: + summary: Delete a DHCP host from a specific subnet + operationId: f652c52b39d57d283401df66a7930b5f + parameters: + - name: subnetId + in: path + description: The ID of the subnet + required: true + schema: + type: integer + responses: + '200': + description: Host deleted successfully + content: + application/json: + schema: + properties: + success: + type: string + type: object + '400': + description: Error occurred + content: + application/json: + schema: + properties: + error: + type: string + type: object +components: + schemas: + Subnet: + properties: + id: + description: The ID of the subnet + type: integer + subnet: + description: The name of the subnet + type: string + next-server: + description: The next server in the subnet + type: string + boot-file-name: + description: The boot file name for the subnet + type: string + reservations: + type: array + items: + description: The reservations in the subnet + type: object + type: object + Host: + properties: + host: + type: string + example: pc11 + macAddress: + type: string + example: 56:6f:c7:4f:00:4f + address: + type: string + example: 172.30.4.11 + type: object \ No newline at end of file -- 2.40.1 From 1607cde72ca6b942c8b239843ed8d7a96ed02908 Mon Sep 17 00:00:00 2001 From: apuente Date: Wed, 15 May 2024 15:10:33 +0200 Subject: [PATCH 5/7] Add Ogdhcp y Ogboot apis definitions --- APIs/web-core-ogboot.yaml | 3 ++- APIs/web-core-ogdhcp.yaml | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/APIs/web-core-ogboot.yaml b/APIs/web-core-ogboot.yaml index 54ae2be..0e997b7 100644 --- a/APIs/web-core-ogboot.yaml +++ b/APIs/web-core-ogboot.yaml @@ -165,4 +165,5 @@ components: type: array items: type: string - description: Direcciones IP de los clientes \ No newline at end of file + description: Direcciones IP de los clientes + \ No newline at end of file diff --git a/APIs/web-core-ogdhcp.yaml b/APIs/web-core-ogdhcp.yaml index c3f3e14..4272105 100644 --- a/APIs/web-core-ogdhcp.yaml +++ b/APIs/web-core-ogdhcp.yaml @@ -343,4 +343,5 @@ components: address: type: string example: 172.30.4.11 - type: object \ No newline at end of file + type: object + \ No newline at end of file -- 2.40.1 From 79e4dc644519b7a68a118431758caa7cee2a386c Mon Sep 17 00:00:00 2001 From: apuente Date: Wed, 15 May 2024 15:14:33 +0200 Subject: [PATCH 6/7] Add Ogdhcp y Ogboot apis definitions --- APIs/web-core-ogboot.yaml | 169 ------------------- APIs/web-core-ogdhcp.yaml | 347 -------------------------------------- 2 files changed, 516 deletions(-) diff --git a/APIs/web-core-ogboot.yaml b/APIs/web-core-ogboot.yaml index 0e997b7..e69de29 100644 --- a/APIs/web-core-ogboot.yaml +++ b/APIs/web-core-ogboot.yaml @@ -1,169 +0,0 @@ -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 - \ No newline at end of file diff --git a/APIs/web-core-ogdhcp.yaml b/APIs/web-core-ogdhcp.yaml index 4272105..e69de29 100644 --- a/APIs/web-core-ogdhcp.yaml +++ b/APIs/web-core-ogdhcp.yaml @@ -1,347 +0,0 @@ -openapi: 3.0.3 -info: - title: Core - ogDHCP - OpenAPI 3.0 - description: |- - API for DHCP service. Used by OGweb. - - Some useful links: - - [The ogDHCP repository](https://ognproject.evlt.uma.es/gitea/opengnsys/ogdhcp) - contact: - name: ogn-qindel - email: seguimiento-ogn-quindel@listas.unizar.es - version: 1.0.0 -paths: - /opengnsys3/rest/core/subnets: - get: - operationId: 8f92a1cbcb8cd176bdc4ae272b3ad303 - responses: - '200': - description: Devuelve todas las subredes - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/Subnet' - '400': - description: Error al obtener las subredes - post: - summary: Add a new DHCP subnet - operationId: 88949bae5e7784ce2721ffafe7c88c0a - requestBody: - description: JSON payload - required: true - content: - application/json: - schema: - properties: - subnetId: - type: integer - example: 2 - mask: - type: string - example: 255.255.255.0 - address: - type: string - example: 192.168.1.0 - nextServer: - type: string - example: 192.168.1.1 - bootFileName: - type: string - example: pxelinux.0 - type: object - responses: - '200': - description: Subnet added successfully - content: - application/json: - schema: - properties: - success: - type: string - type: object - '400': - description: Error occurred - content: - application/json: - schema: - properties: - error: - type: string - type: object - /opengnsys3/rest/core/subnets/{subnetId}: - put: - summary: Modify a DHCP subnet - operationId: 548b55fc0e1ad59ea5b5c909dfd07c71 - parameters: - - name: subnetId - in: path - description: ID of the subnet to modify - required: true - schema: - type: integer - requestBody: - description: Data to modify the subnet - required: true - content: - application/json: - schema: - properties: - mask: - type: string - address: - type: string - nextServer: - type: string - bootFileName: - type: string - type: object - responses: - '200': - description: Subnet modified successfully - content: - application/json: - schema: - properties: - success: - type: string - type: object - '400': - description: Error occurred - content: - application/json: - schema: - properties: - error: - type: string - type: object - delete: - summary: Delete a DHCP subnet - operationId: c1c1c34729bdd85857b22e6e2bdc41de - parameters: - - name: subnetId - in: path - description: ID of the subnet to delete - required: true - schema: - type: integer - responses: - '200': - description: Subnet deleted successfully - content: - application/json: - schema: - properties: - success: - type: string - type: object - '400': - description: Error occurred - content: - application/json: - schema: - properties: - error: - type: string - type: object - /opengnsys3/rest/core/subnets/{subnetId}/hosts: - get: - summary: Get all hosts in a subnet - operationId: 0989ca622a6a7e23f5af8e3bdd6f6b05 - parameters: - - name: subnetId - in: path - description: The ID of the subnet - required: true - schema: - type: integer - responses: - '200': - description: List of hosts in the subnet - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/Host' - '400': - description: Error occurred - content: - application/json: - schema: - properties: - error: - type: string - type: object - '500': - description: Server error - content: - application/json: - schema: - properties: - error: - type: string - type: object - put: - summary: Update a DHCP host - operationId: 1541441cd53685aaf6df45ab48befaa8 - parameters: - - name: subnetId - in: path - description: The ID of the subnet - required: true - schema: - type: integer - requestBody: - description: Data for the host to update - required: true - content: - application/json: - schema: - properties: - host: - type: string - example: pc11 - oldMacAddress: - type: string - example: 56:6f:c7:4f:00:4f - oldAddress: - type: string - example: 192.168.1.11 - macAddress: - type: string - example: 56:6f:c7:4f:01:01 - address: - type: string - example: 192.168.1.11 - type: object - responses: - '200': - description: Host updated successfully - content: - application/json: - schema: - properties: - success: - type: string - type: object - '400': - description: Error occurred - content: - application/json: - schema: - properties: - error: - type: string - type: object - post: - summary: Add a DHCP host to a subnet - operationId: 3f897dcd7c04787ac9c42ddbb57cb800 - parameters: - - name: subnetId - in: path - description: ID of the subnet to add the host to - required: true - schema: - type: integer - requestBody: - description: Data for the new host - required: true - content: - application/json: - schema: - properties: - host: - type: string - example: pc11 - macAddress: - type: string - example: 56:6f:c7:4f:00:4f - address: - type: string - example: 172.30.4.11 - type: object - responses: - '200': - description: Host added successfully - content: - application/json: - schema: - properties: - success: - type: string - type: object - '400': - description: Error occurred - content: - application/json: - schema: - properties: - error: - type: string - type: object - delete: - summary: Delete a DHCP host from a specific subnet - operationId: f652c52b39d57d283401df66a7930b5f - parameters: - - name: subnetId - in: path - description: The ID of the subnet - required: true - schema: - type: integer - responses: - '200': - description: Host deleted successfully - content: - application/json: - schema: - properties: - success: - type: string - type: object - '400': - description: Error occurred - content: - application/json: - schema: - properties: - error: - type: string - type: object -components: - schemas: - Subnet: - properties: - id: - description: The ID of the subnet - type: integer - subnet: - description: The name of the subnet - type: string - next-server: - description: The next server in the subnet - type: string - boot-file-name: - description: The boot file name for the subnet - type: string - reservations: - type: array - items: - description: The reservations in the subnet - type: object - type: object - Host: - properties: - host: - type: string - example: pc11 - macAddress: - type: string - example: 56:6f:c7:4f:00:4f - address: - type: string - example: 172.30.4.11 - type: object - \ No newline at end of file -- 2.40.1 From 1ae3e8ed9aa9a7e41035c908499e9aef21e63699 Mon Sep 17 00:00:00 2001 From: apuente Date: Wed, 15 May 2024 15:14:47 +0200 Subject: [PATCH 7/7] Add Ogdhcp y Ogboot apis definitions --- APIs/web-core-ogboot.yaml | 169 +++++++++++++++++++ APIs/web-core-ogdhcp.yaml | 347 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 516 insertions(+) diff --git a/APIs/web-core-ogboot.yaml b/APIs/web-core-ogboot.yaml index e69de29..0e997b7 100644 --- a/APIs/web-core-ogboot.yaml +++ b/APIs/web-core-ogboot.yaml @@ -0,0 +1,169 @@ +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 + \ No newline at end of file diff --git a/APIs/web-core-ogdhcp.yaml b/APIs/web-core-ogdhcp.yaml index e69de29..4272105 100644 --- a/APIs/web-core-ogdhcp.yaml +++ b/APIs/web-core-ogdhcp.yaml @@ -0,0 +1,347 @@ +openapi: 3.0.3 +info: + title: Core - ogDHCP - OpenAPI 3.0 + description: |- + API for DHCP service. Used by OGweb. + + Some useful links: + - [The ogDHCP repository](https://ognproject.evlt.uma.es/gitea/opengnsys/ogdhcp) + contact: + name: ogn-qindel + email: seguimiento-ogn-quindel@listas.unizar.es + version: 1.0.0 +paths: + /opengnsys3/rest/core/subnets: + get: + operationId: 8f92a1cbcb8cd176bdc4ae272b3ad303 + responses: + '200': + description: Devuelve todas las subredes + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Subnet' + '400': + description: Error al obtener las subredes + post: + summary: Add a new DHCP subnet + operationId: 88949bae5e7784ce2721ffafe7c88c0a + requestBody: + description: JSON payload + required: true + content: + application/json: + schema: + properties: + subnetId: + type: integer + example: 2 + mask: + type: string + example: 255.255.255.0 + address: + type: string + example: 192.168.1.0 + nextServer: + type: string + example: 192.168.1.1 + bootFileName: + type: string + example: pxelinux.0 + type: object + responses: + '200': + description: Subnet added successfully + content: + application/json: + schema: + properties: + success: + type: string + type: object + '400': + description: Error occurred + content: + application/json: + schema: + properties: + error: + type: string + type: object + /opengnsys3/rest/core/subnets/{subnetId}: + put: + summary: Modify a DHCP subnet + operationId: 548b55fc0e1ad59ea5b5c909dfd07c71 + parameters: + - name: subnetId + in: path + description: ID of the subnet to modify + required: true + schema: + type: integer + requestBody: + description: Data to modify the subnet + required: true + content: + application/json: + schema: + properties: + mask: + type: string + address: + type: string + nextServer: + type: string + bootFileName: + type: string + type: object + responses: + '200': + description: Subnet modified successfully + content: + application/json: + schema: + properties: + success: + type: string + type: object + '400': + description: Error occurred + content: + application/json: + schema: + properties: + error: + type: string + type: object + delete: + summary: Delete a DHCP subnet + operationId: c1c1c34729bdd85857b22e6e2bdc41de + parameters: + - name: subnetId + in: path + description: ID of the subnet to delete + required: true + schema: + type: integer + responses: + '200': + description: Subnet deleted successfully + content: + application/json: + schema: + properties: + success: + type: string + type: object + '400': + description: Error occurred + content: + application/json: + schema: + properties: + error: + type: string + type: object + /opengnsys3/rest/core/subnets/{subnetId}/hosts: + get: + summary: Get all hosts in a subnet + operationId: 0989ca622a6a7e23f5af8e3bdd6f6b05 + parameters: + - name: subnetId + in: path + description: The ID of the subnet + required: true + schema: + type: integer + responses: + '200': + description: List of hosts in the subnet + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Host' + '400': + description: Error occurred + content: + application/json: + schema: + properties: + error: + type: string + type: object + '500': + description: Server error + content: + application/json: + schema: + properties: + error: + type: string + type: object + put: + summary: Update a DHCP host + operationId: 1541441cd53685aaf6df45ab48befaa8 + parameters: + - name: subnetId + in: path + description: The ID of the subnet + required: true + schema: + type: integer + requestBody: + description: Data for the host to update + required: true + content: + application/json: + schema: + properties: + host: + type: string + example: pc11 + oldMacAddress: + type: string + example: 56:6f:c7:4f:00:4f + oldAddress: + type: string + example: 192.168.1.11 + macAddress: + type: string + example: 56:6f:c7:4f:01:01 + address: + type: string + example: 192.168.1.11 + type: object + responses: + '200': + description: Host updated successfully + content: + application/json: + schema: + properties: + success: + type: string + type: object + '400': + description: Error occurred + content: + application/json: + schema: + properties: + error: + type: string + type: object + post: + summary: Add a DHCP host to a subnet + operationId: 3f897dcd7c04787ac9c42ddbb57cb800 + parameters: + - name: subnetId + in: path + description: ID of the subnet to add the host to + required: true + schema: + type: integer + requestBody: + description: Data for the new host + required: true + content: + application/json: + schema: + properties: + host: + type: string + example: pc11 + macAddress: + type: string + example: 56:6f:c7:4f:00:4f + address: + type: string + example: 172.30.4.11 + type: object + responses: + '200': + description: Host added successfully + content: + application/json: + schema: + properties: + success: + type: string + type: object + '400': + description: Error occurred + content: + application/json: + schema: + properties: + error: + type: string + type: object + delete: + summary: Delete a DHCP host from a specific subnet + operationId: f652c52b39d57d283401df66a7930b5f + parameters: + - name: subnetId + in: path + description: The ID of the subnet + required: true + schema: + type: integer + responses: + '200': + description: Host deleted successfully + content: + application/json: + schema: + properties: + success: + type: string + type: object + '400': + description: Error occurred + content: + application/json: + schema: + properties: + error: + type: string + type: object +components: + schemas: + Subnet: + properties: + id: + description: The ID of the subnet + type: integer + subnet: + description: The name of the subnet + type: string + next-server: + description: The next server in the subnet + type: string + boot-file-name: + description: The boot file name for the subnet + type: string + reservations: + type: array + items: + description: The reservations in the subnet + type: object + type: object + Host: + properties: + host: + type: string + example: pc11 + macAddress: + type: string + example: 56:6f:c7:4f:00:4f + address: + type: string + example: 172.30.4.11 + type: object + \ No newline at end of file -- 2.40.1