Commit 21c574cb authored by seykron's avatar seykron

Adds documentation

parent 7b5b07a8
......@@ -5,7 +5,7 @@
[Iris](https://telegram.me/Ir1sBot) es la mensajera de R'lyeh, es los ojos de Cthulhu en el ciberespacio.
Desde la superficie hasta las profundidades del Polo de Inaccesibilidad, [Iris](https://telegram.me/Ir1sBot)
recibe y comunica todo lo que pase en R'lyeh; es el único ser que puede entrar y salir del sueño de Cthulhu sin
recibe y comunica todo lo que pasa en R'lyeh; es el único ser que puede entrar y salir del sueño de Cthulhu sin
perder la cordura.
Por eso la invocamos para que avise en el ciberespacio cuando hay novedades importantes en R'lyeh.
......@@ -36,6 +36,37 @@ los mensajes destinados a la comunidad.
[/inbox_count](src/main/kotlin/be/rlab/iris/domain/command/InboxCount.kt) para pedirle a
[Iris](https://telegram.me/Ir1sBot) que nos cuente cuántos mensajes tenemos pendientes y de qué fuentes.
## Pedirle a Iris que envie mensajes
Para enviar mensajes a todas las personas subscriptas a Iris, se debe utilizar el siguiente
[servicio web](src/main/kotlin/be/rlab/iris/application/PushEventController.kt):
```
Endpoint: http://localhost:8090/eoc/notifications
Método: POST
Headers:
Content-Type: application/json
Body:
{
"user_name": "cthulhu",
"subject": "test notification",
"summary": "service is down",
"event_type":"SERVICE_STATUS",
"additional_data": {
"service_host": "https://nonexistent.url"
}
}
```
Este ejemplo con curl sería de la siguiente manera:
```
curl -i -XPOST \
-H'Content-Type: application/json' \
-d'{"user_name":"cthulhu","subject":"test notification","summary": "a summary","event_type":"SERVICE_STATUS","additional_data":{"service_host":"https://nonexistent.url"}}' \
http://localhost:8090/eoc/notifications
```
## Desarrollo
[Iris](https://telegram.me/Ir1sBot) es un bot de Telegram basado en [Tehanu](https://git.rlab.be/seykron/tehanu).
......@@ -95,34 +126,3 @@ be.rlab.iris.Application
Con esto ya quedaría corriendo la aplicación en el puerto 8090 y se pueden enviar comandos desde Telegram
al usuario del bot.
### Notificaciones
Para enviar mensajes a todas las personas subscriptas al bot, se debe utilizar el siguiente
[servicio web](src/main/kotlin/be/rlab/iris/application/PushEventController.kt):
```
Endpoint: http://localhost:8090/eoc/notifications
Método: POST
Headers:
Content-Type: application/json
Body:
{
"user_name": "cthulhu",
"subject": "test notification",
"summary": "service is down",
"event_type":"SERVICE_STATUS",
"additional_data": {
"service_host": "https://nonexistent.url"
}
}
```
Este ejemplo con curl sería de la siguiente manera:
```
curl -i -XPOST \
-H'Content-Type: application/json' \
-d'{"user_name":"cthulhu","subject":"test notification","summary": "a summary","event_type":"SERVICE_STATUS","additional_data":{"service_host":"https://nonexistent.url"}}' \
http://localhost:8090/eoc/notifications
```
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment