From 300abccacaf8df7f9e9ef9d3aef179007fae5e42 Mon Sep 17 00:00:00 2001 From: lgromero Date: Thu, 22 Feb 2024 14:24:33 +0100 Subject: [PATCH] refs #208 removes innecesaries endpoints --- README.md | 47 ++++++++++++----------------------------------- 1 file changed, 12 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index 17f39d5..8f4cd22 100644 --- a/README.md +++ b/README.md @@ -17,16 +17,15 @@ El presente documento detalla los endpoints del API con sus respectivos parámet 2. [Mostrar información de todos los clientes ogLive instalados](#mostrar-información-de-todos-los-clientes-oglive-instalados) - `/ogboot/clients/oglives` 3. [Mostrar información del cliente ogLive predeterminado](#mostrar-información-del-cliente-oglive-predeterminado) - `/ogboot/clients/oglives/show-default` 4. [Mostrar información de un cliente ogLive específico](#mostrar-información-de-un-cliente-oglive-específico) - `/ogboot/clients/oglives/show/{Index|Dir}` -5. [Buscar índice o directorio del cliente ogLive correspondiente](#buscar-índice-o-directorio-del-cliente-oglive-correspondiente) - `/ogboot/clients/oglives/{Index}` -6. [Obtener todos los archivos de arranque](#obtener-todos-los-archivos-de-arranque) - `/ogboot/clients/pxes` -7. [Obtener archivo de arranque](#obtener-archivo-de-arranque) - `/ogboot/clients/pxes/{mac}` -8. [Crear archivo de arranque](#crear-archivo-de-arranque) - `/ogboot/clients/pxes` -9. [Eliminar archivo de arranque](#eliminar-archivo-de-arranque) - `/ogboot/clients/pxes` -10. [Actualizar repositorio de arranque](#actualizar-repositorio-de-arranque) - `/ogboot/clients/pxe/update-repo` -11. [Mostrar menú de descarga de imagen de ogLive](#mostrar-menú-de-descarga-de-imagen-de-oglive) - `/ogboot/images/download` -12. [Descargar imagen de ogLive específica](#descargar-imagen-de-oglive-específica) - `/images/download/{iso}` -13. [Instalar nuevo cliente ogLive desde imagen descargada](#instalar-nuevo-cliente-oglive-desde-imagen-descargada) - `/ogboot/images/upload/{iso}` -14. [Elimina cliente ogLive](#desinstalar-cliente-oglive-y-eliminar-imagen) - `/ogboot/images/remove/{iso}` +5. [Obtener todos los archivos de arranque](#obtener-todos-los-archivos-de-arranque) - `/ogboot/clients/pxes` +6. [Obtener archivo de arranque](#obtener-archivo-de-arranque) - `/ogboot/clients/pxes/{mac}` +7. [Crear archivo de arranque](#crear-archivo-de-arranque) - `/ogboot/clients/pxes` +8. [Eliminar archivo de arranque](#eliminar-archivo-de-arranque) - `/ogboot/clients/pxes` +9. [Actualizar repositorio de arranque](#actualizar-repositorio-de-arranque) - `/ogboot/clients/pxe/update-repo` +10. [Mostrar menú de descarga de imagen de ogLive](#mostrar-menú-de-descarga-de-imagen-de-oglive) - `/ogboot/images/download` +11. [Descargar imagen de ogLive específica](#descargar-imagen-de-oglive-específica) - `/images/download/{iso}` +12. [Instalar nuevo cliente ogLive desde imagen descargada](#instalar-nuevo-cliente-oglive-desde-imagen-descargada) - `/ogboot/images/upload/{iso}` +13. [Elimina cliente ogLive](#desinstalar-cliente-oglive-y-eliminar-imagen) - `/ogboot/images/remove/{iso}` @@ -155,28 +154,6 @@ curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/clients/ogliv - **Código 200 OK:** La información sobre el cliente ogLive específico se obtuvo exitosamente. - **Contenido:** Información sobre el cliente ogLive específico en formato JSON. -### Buscar Índice o Directorio del Cliente ogLive Correspondiente - -Muestra el ogLive correspondiente al proporcionar su índice o directorio -**URL:** `/ogboot/clients/oglives/{Index}` -**Método HTTP:** GET - -**Parámetros de entrada:** -- `Index|Dir`: Índice numérico o directorio del cliente ogLive. - -**Ejemplo de Solicitud:** - -```bash -curl -X GET -H "Authorization: $API_KEY" http://example.com/openGnsys/clients/oglives/0 - -ogLive-5.11.0-r20210413 - -``` - -**Respuestas:** -- **Código 200 OK:** La búsqueda del índice o directorio del cliente ogLive correspondiente se realizó exitosamente. - - **Contenido:** Índice numérico o directorio del cliente ogLive correspondiente en formato JSON. - ### Obtener Todos los Archivos de Arranque @@ -212,7 +189,7 @@ Devuelve el archivo de arranque PXE del ordenador con la dirección MAC correspo ### Crear Archivo de Arranque -Crea un archivo de arranque PXE para el ordenador basado en la plantilla indicada y utilizando los datos almacenados en la base de datos. +Crea un archivo de arranque PXE para el ordenador basado en la plantilla indicada. **URL:** `/ogboot/clients/pxes` **Método HTTP:** POST @@ -321,9 +298,9 @@ curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/images/downlo - **Código 200 OK:** La imagen de ogLive se descargó exitosamente. - **Código 400 Bad Request:** La solicitud es incorrecta. La imagen de ogLive no se ha descargado correctamente. -### Instalar Nuevo Cliente ogLive desde Imagen Descargada +### Desplegar Nuevo Cliente ogLive desde Imagen Descargada -Instala un nuevo cliente ogLive utilizando una imagen de ogLive previamente descargada. +Despliega un nuevo cliente ogLive utilizando una imagen de ogLive previamente descargada. **URL:** `/ogboot/images/upload/{iso}` **Método HTTP:** POST