docs: add full documentation for all functions in tienda/views.py
Agent-Logs-Url: https://github.com/dsaub/proyecto-final/sessions/49df17c8-213a-4e23-adfe-465a0104f6a3 Co-authored-by: dsaub <54474838+dsaub@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
47ea00c822
commit
ed92991872
@@ -0,0 +1,41 @@
|
||||
# `search_suggestions`
|
||||
|
||||
**Archivo:** `tienda/views.py`
|
||||
**URL:** `/tienda/sugerencias/`
|
||||
**Tipo:** Vista pública (API AJAX)
|
||||
|
||||
## Descripción
|
||||
|
||||
Endpoint JSON que devuelve hasta 8 sugerencias de productos para el autocompletado de la barra de búsqueda. Solo responde si el término de búsqueda tiene al menos 2 caracteres.
|
||||
|
||||
Busca coincidencias en el nombre del producto y en la descripción breve.
|
||||
|
||||
## Firma
|
||||
|
||||
```python
|
||||
def search_suggestions(request: HttpRequest):
|
||||
```
|
||||
|
||||
## Parámetros
|
||||
|
||||
| Nombre | Tipo | Descripción |
|
||||
|-----------|---------------|-----------------------|
|
||||
| `request` | `HttpRequest` | Petición HTTP de Django. |
|
||||
|
||||
## Parámetros GET
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
|-----------|-------|------------------------------------------|
|
||||
| `q` | `str` | Texto a buscar (mínimo 2 caracteres). |
|
||||
|
||||
## Respuesta
|
||||
|
||||
```json
|
||||
{
|
||||
"suggestions": [
|
||||
{ "name": "Camiseta azul", "id": 42, "price": 19.99 }
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Si la consulta tiene menos de 2 caracteres, `suggestions` es una lista vacía.
|
||||
Reference in New Issue
Block a user