Skip to content
This repository has been archived by the owner on May 14, 2021. It is now read-only.

Commit

Permalink
Improved docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Martín S committed Sep 6, 2019
1 parent 5ca2410 commit b64d73c
Show file tree
Hide file tree
Showing 4 changed files with 426 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/detalle/endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,3 +179,5 @@ La tabla de CSV tiene las siguientes columnas:
Devuelve un información sobre cantidades de entidad por fuente y por tipo de entidad en QuienEsQuien.wiki.

Tiene dos objetos, uno de fuentes `sources` que tiene por cada fuente la cantidad de elementos de cada tipo de entidad. Y otro de colecciones `collections` que tiene la cantidad elementos de cada tipo de entidad.

Nota: Este endpoint está en construcción.
39 changes: 39 additions & 0 deletions docs/detalle/errores.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,42 @@ Hay un límite máximo de 5 segundos a las consultas a la base de datos. Las con

}
```

# Resultado vacío

Si el conjunto de filtros eliminan todos los registros, lo que ocurre es que se devuelve un estado de éxito pero sin resultados.

Ejemplo:

```
{
"status": "success",
"size": 0,
"limit": 1,
"offset": 0,
"pages": 0,
"count": 0,
"data": [ ]
}
```

# Exceso de tiempo de procesamiento

Las consultas de API no deben tardar más de 6 segundos en ejecutarse en la base de datos, es por esto que si se realizan consultas sobre campos indexistentes o que no tienen índice o que por sus relaciones con otras tablas o por otras razones toman más de 6 segundos, estas consultas devuelven un mensaje de error.

Ejemplo:
```
{
"status": "error",
"size": 0,
"limit": 1,
"offset": 0,
"pages": null,
"count": "error: MongoError: Exec error resulting in state DEAD :: caused by :: errmsg: \"operation exceeded time limit\"",
"data": "error: MongoError: Executor error during find command :: caused by :: errmsg: \"operation exceeded time limit\""
}
```

0 comments on commit b64d73c

Please sign in to comment.