From 81f937b55c9ec3de81d3652b484df020db940384 Mon Sep 17 00:00:00 2001 From: turt2live Date: Sun, 28 May 2017 01:45:19 -0600 Subject: [PATCH] Add RSS bot docs for vector scalar Part of #13 --- docs/scalar_server_api.md | 43 ++++++++++++++++++++++++++++++++++++--- 1 file changed, 40 insertions(+), 3 deletions(-) diff --git a/docs/scalar_server_api.md b/docs/scalar_server_api.md index a5fa503..7edb7d1 100644 --- a/docs/scalar_server_api.md +++ b/docs/scalar_server_api.md @@ -27,16 +27,53 @@ None of these are officially documented, and are subject to change. **Response**: ``` { - "bot_user_id":"@neb_giphy:matrix.org" + "bot_user_id": "@neb_giphy:matrix.org", + "integrations": [] } ``` +*Note*: `integrations` appears to only be present when there are settings needed for the integration. + +**RSS Bot Response**: +``` +{ + "bot_user_id": "@_neb_rssbot_=40travis=3at2l.io:matrix.org", + "integrations": [{ + "type": "rssbot", + "user_id": "@travis:t2l.io", + "config": { + "feeds": { + "https://ci.t2l.io/view/all/rssAll": { + "poll_interval_mins": 0, + "is_failing": false, + "last_updated_ts_secs": 1495957242, + "rooms": ["!JmvocvDuPTYUfuvKgs:t2l.io"] + } + } + }, + "self":false + }] +} +``` + ## POST `/api/removeIntegration?scalar_token=...` **Body**: ``` { - "type":"giphy", - "room_id":"!RtMvcvtjkfHeFbjzWM:t2l.io" + "type": "giphy", + "room_id": "!RtMvcvtjkfHeFbjzWM:t2l.io" +} +``` + +## POST `/api/integrations/rssbot/configureService?scalar_token=...` + +**Body**: +``` +{ + "room_id": "!JmvocvDuPTYUfuvKgs:t2l.io", + "feeds": { + "https://ci.t2l.io/view/all/rssAll": {} + } } ``` \ No newline at end of file