Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
…ar-api

* 'master' of https://github.com/datosgobar/series-tiempo-ar-api:
  Fijo versión de datajsonar
  Paso a usar nueva api de analytics
  Saco count del resultado de import analytics
  Uso https para swagger
  Agrego docs de search a swagger
  (WIP) docs de swagger para /search
  Actualizo RTD con docs de /search

# Conflicts:
#	mkdocs.yml
  • Loading branch information
abenassi committed Aug 24, 2018
2 parents 028c340 + a6f9058 commit 4022bbf
Show file tree
Hide file tree
Showing 9 changed files with 574 additions and 266 deletions.
2 changes: 2 additions & 0 deletions docs/api_reference.md → docs/reference/api_reference.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Referencia API

Endpoint: `/series`

La API de Series de Tiempo permite obtener datos de una o más series, permitiendo hacer filtros por el índice de tiempo, cambios de granularidad en la dimensión temporal y cambios en la unidad de los valores de la serie, entre otras operaciones.

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
Expand Down
97 changes: 97 additions & 0 deletions docs/reference/search_reference.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
# Referencia búsqueda

Endpoint: `/search`

Se provee un endpoint adicional para funcionar como buscador de series a partir de un texto, proporcionando además algunos filtros como por tema o por unidades de las series.

## Tabla de parámetros

<table>
<tr>
<td>Nombre</td>
<td>Requerido</td>
<td>Tipo</td>
<td>Default</td>
<td>Ejemplos</td>
</tr>
<tr>
<td>q</td>
<td>Si</td>
<td>Texto</td>
<td>N/A</td>
<td>q=ipc</td>
</tr>
<tr>
<td>dataset_theme</a></td>
<td>No</td>
<td>Uno de los valores listados en /search/dataset_theme</em></td>
<td>N/A</td>
<td>dataset_theme="Finanzas Públicas"</td>
</tr>
<tr>
<td>units</a></td>
<td>No</td>
<td>Uno de los valores listados en /search/field_units</td>
<td>N/A</td>
<td>units="Millones de pesos"</td>
</tr>
<tr>
<td>dataset_publisher_name</a></td>
<td>No</td>
<td>Uno de los valores listados en /search/dataset_publisher_name</td>
<td>N/A</td>
<td>dataset_publisher_name="Subsecretaría de Programación Macroeconómica."</td>
</tr>
<tr>
<td>dataset_source</a></td>
<td>No</td>
<td>Uno de los valores listados en /search/dataset_source</td>
<td>N/A</td>
<td>dataset_source="Ministerio de Hacienda"</td>
</tr>
<tr>
<td>catalog_id</a></td>
<td>No</td>
<td>Uno de los valores listados en /search/catalog_id</td>
<td>N/A</td>
<td>catalog_id="sspm"</td>
</tr>
<tr>
<td>limit</a></td>
<td>No</td>
<td>Número entero positivo, no mayor que 1000.</td>
<td class="s4" dir="ltr">10</td>
<td>limit=50</td>
</tr>
<tr>
<td>start</a></td>
<td>No</td>
<td>Número entero positivo o 0.</td>
<td class="s4" dir="ltr">0</td>
<td>start=100</td>
</tr>
</table>

### `q`

Texto de entrada a buscar en la base de series de tiempo. Puede ser abritrariamente largo, pero se recomienda ingresar una o más palabras clave.

### `dataset_theme`, `units`, `dataset_publisher_name`, `dataset_source`, `catalog_id`

Estos parámetros pueden ser usados como filtro en los resultados de la búsqueda. Al ser especificados, se aplica el filtro determinado, haciendo que se muestren únicamente aquellos resultados que sean compatibles con la especificación. Por ejemplo, si hacemos un pedido con `units=Millones de pesos`, el resultado solo contendrá series de tiempo que estén expresados en millones de dólares.

Los términos que aceptan estos parámetros son términos especificados en _endpoints auxiliares_, que devuelven la lista entera de filtros aceptados por cada endpoint. Un pedido a `/search/field_units`(http://apis.datos.gob.ar/series/api/search/field_units/), entonces, devuelve una lista de los términos que se le pueden pasar al parámetro `units`. Cualquier otra opción devolverá una lista vacía de resultados (al no haber matches). Consultar la tabla de parámetros para ver los endpoints auxiliares.

### `limit`

Este parámetro es utilizado junto a [`start`](#start) para controlar el paginado de los resultados devueltos por la API. Debe especificarse un número entero positivo, no mayor que 1000, ya que esa es la cantidad máxima de resultados devueltos por la API. El valor por defecto si no se especifica valor alguno es 10.

### `start`

Este parámetro es utilizado junto a [`limit`](#limit) para controlar el paginado de los resultados devueltos por la API. Debe especificarse un número entero positivo o 0. El valor por defecto si no se especifica valor alguno es 0.

El [`start`](#start) indica el "número de resultados después del inicio" que se saltea el buscador para el armado de la respuesta.




Loading

0 comments on commit 4022bbf

Please sign in to comment.