Skip to content

Commit

Permalink
Update READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
gustavoerivero committed Jun 10, 2023
1 parent 3be8c84 commit acb5c1f
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
10 changes: 5 additions & 5 deletions README-ES.md
Original file line number Diff line number Diff line change
Expand Up @@ -308,22 +308,22 @@ type TBsCalculatedAverage = {
El paquete también está desplegado y funciona como API para aquellos usuarios que no quieran o no puedan incorporarlo a sus proyectos como dependencia.
Para acceder a la API deben utilizar la ruta https://venecodollar.vercel.app/api/v1.
Para acceder a la API deben utilizar la ruta https://venecodollar.vercel.app/api/v2.
Asimismo, pueden acceder a la documentación hecha en swagger para el proyecto ubicada aquí [documentación de la API venecodollar](https://venecodollar.vercel.app/api/doc).
#### Obtener todas las entidades
```http
GET /api/v1/dollar
GET /api/v2/dollar
```
Este endpoint permite obtener todas las entidades de seguimiento del dólar con su respectivo nombre y fecha de última actualización, así como una media de todas las entidades activas (es decir, las que tienen un valor del dólar superior a cero).
#### Obtener entidades por un nombre
```http
GET /api/v1/dollar/entity?name=${name}
GET /api/v2/dollar/entity?name=${name}
```
| Parámetro Tipo Descripción |
Expand All @@ -335,7 +335,7 @@ Este endpoint permite obtener todas las entidades de seguimiento del dólar por
#### Calcular Bs
```http
GET /api/v1/dollar/toBs?dollar=${dollar}&entity={entity}
GET /api/v2/dollar/toBs?dollar=${dollar}&entity={entity}
```
| Parameter | Type | Description |
Expand All @@ -348,7 +348,7 @@ Este endpoint permite obtener todas las entidades de monitoreo de dólares calcu
#### Calcular Dólar
```http
GET /api/v1/dollar/toDollar?bs=${bs}&entity={entity}
GET /api/v2/dollar/toDollar?bs=${bs}&entity={entity}
```
| Parameter | Type | Description |
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -262,22 +262,22 @@ type TBsCalculatedAverage = {
The package is also deployed and works as an API for those users who do not want to or cannot incorporate it into their projects as a dependency.
To access the API they should use the path https://venecodollar.vercel.app/api/v1.
To access the API they should use the path https://venecodollar.vercel.app/api/v2.
Likewise, you can access the documentation made in swagger for the project located here [venecodollar API documentation](https://venecodollar.vercel.app/api/doc).
#### Get all entities
```http
GET /api/v1/dollar
GET /api/v2/dollar
```
This endpoint allows obtaining all the dollar monitoring entities with their respective name and last update date, as well as an average of all the active entities (i.e., those with a dollar value greater than zero).
#### Get entities by name
```http
GET /api/v1/dollar/entity?name=${name}
GET /api/v2/dollar/entity?name=${name}
```
| Parameter | Type | Description |
Expand All @@ -289,7 +289,7 @@ This endpoint allows to obtain all the monitoring entities of the dollar by the
#### Calculate Bs
```http
GET /api/v1/dollar/toBs?dollar=${dollar}&entity={entity}
GET /api/v2/dollar/toBs?dollar=${dollar}&entity={entity}
```
| Parameter | Type | Description |
Expand All @@ -302,7 +302,7 @@ This endpoint allows obtaining all the dollar monitoring entities while calculat
#### Calculate Dollar
```http
GET /api/v1/dollar/toDollar?bs=${bs}&entity={entity}
GET /api/v2/dollar/toDollar?bs=${bs}&entity={entity}
```
| Parameter | Type | Description |
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "venecodollar",
"version": "2.0.0",
"version": "2.0.1",
"description": "Library to consult the different dollar values and their average in terms of bolivars.",
"keywords": [
"dollar",
Expand Down

1 comment on commit acb5c1f

@vercel
Copy link

@vercel vercel bot commented on acb5c1f Jun 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.