refs #271 adds descriptions to some returns content

pull/2/head
Luis Gerardo Romero Garcia 2024-04-19 13:01:21 +02:00
parent 59387e1b3d
commit 10927d2195
1 changed files with 28 additions and 2 deletions

View File

@ -58,6 +58,20 @@ curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/v1/config
"min-release": "r20190601"
}
```
- **config-file**: Ruta del archivo de configuración que usa oglivecli para guardar los oglives instalados.
- **download-url**: URL base desde la cual se descargan las imágenes de oglive.
- **download-dir**: Ruta del directorio en el cual se almacenan las imágenes de oglive descargadas
- **install-dir**: La ruta del directorio donde se instalan las imágenes de oglive
- **default-name**: Nombre predeterminado utilizado para los clientes ogLive.
- **min-release**: La versión mínima recomendada para la instalación de imágenes oglives.
Estas definiciones proporcionan una comprensión clara de cada uno de los parámetros de contenido dentro de la configuración del ogboot.
- **Código 400 Bad Request:** La solicitud es incorrecta. La configuración del ogboot no se ha obtenido correctamente.
@ -76,8 +90,9 @@ curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/v1/status
```
**Respuestas:**
- **Código 200 OK:** La status de ogboot se obtuvo exitosamente.
- **Contenido:** .
- **Código 200 OK:** El status de ogboot se obtuvo exitosamente.
- **Contenido:**
```
Some installed ogLive aren't fully compatible: , , ogLive-3.19.0-i386-r4795
Problems detected:
```
@ -123,6 +138,17 @@ curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/v1/clients/og
]
```
- **distribution**: Distribución del sistema operativo de la imagen ogLive
- **kernel**: Versión del kernel del sistema operativo utilizado por la imagen ogLive
- **architecture**: Arquitectura del hardware de la imagen ogLive
- **revision**: Versión de la imagen ogLive
- **directory**: Directorio donde se encuentra instalado el cliente ogLive en el sistema.
- **iso**: Nombre del archivo ISO utilizado para instalar el cliente ogLive.
**Respuestas:**
- **Código 200 OK:** La información sobre todos los clientes ogLive instalados se obtuvo exitosamente.