mirrors/remark42
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add docs for site rss, adjust .rest file to demo site

Browse Source
This commit is contained in:
Umputun
2018-05-14 10:55:23 -05:00
parent f45aac17b3
commit 84980a664d
2 changed files with 17 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+5 -1
View File
@@ -326,8 +326,12 @@ Sort can be `time` or `score`. Supported sort order with prefix -/+, i.e. `-time
Admins []string `json:"admins"`
Auth []string `json:"auth_providers"`
}
```
```
### RSS feeds
* `GET /api/v1/rss/post?site=site-id&url=post-url` - rss feed for a post
* `GET /api/v1/rss/site?site=site-id` - rss feed for given site
### Admin
remark.rest
+12 -14
View File
@@ -1,9 +1,9 @@
### find request with tree
GET {{host}}/api/v1/find?site=remark&sort=-score&format=tree&url=https://radio-t.com/p/2017/12/16/podcast-576/
GET {{host}}/api/v1/find?site=remark&sort=-score&format=tree&url=https://remark42.com/demo/
### find request with plain
GET {{host}}/api/v1/find?site=remark&sort=-score&format=plain&url=https://radio-t.com/p/2017/12/16/podcast-576/
GET {{host}}/api/v1/find?site=remark&sort=-score&format=plain&url=https://remark42.com/demo/
### last 50 comments
GET {{host}}/api/v1/last/50?site=remark
@@ -38,16 +38,16 @@ Content-Type: application/json
}
### pin comment
PUT {{host}}/api/v1/admin/pin/3665976683?site=remark&url=https://radio-t.com/p/2017/12/16/podcast-576/&pin=1
PUT {{host}}/api/v1/admin/pin/3665976683?site=remark&url=https://remark42.com/demo/&pin=1
### vote for comment
PUT {{host}}/api/v1/vote/3665976683?site=remark&url=https://radio-t.com/p/2017/12/16/podcast-576/&vote=1
PUT {{host}}/api/v1/vote/3665976683?site=remark&url=https://remark42.com/demo/&vote=1
### get user info
GET {{host}}/api/v1/user
### get comment by id
GET {{host}}/api/v1/id/3665976683?site=remark&url=https://radio-t.com/p/2017/12/16/podcast-576/
GET {{host}}/api/v1/id/3665976683?site=remark&url=https://remark42.com/demo/
### get comment by id 2
GET {{host}}/api/v1/id/a2ddb8d2f65008ee1a1e3af8df0f26beb042309c?site=remark&url=https://radio-t.com/blah1
@@ -59,7 +59,7 @@ GET {{host}}/api/v1/comments?site=remark&user=disqus_umputun&limit=5
GET {{host}}/api/v1/comments?site=remark&user=disqus_kpmy
### get count
GET {{host}}/api/v1/count?site=remark&url=https://radio-t.com/p/2017/12/16/podcast-576/
GET {{host}}/api/v1/count?site=remark&url=https://remark42.com/demo/
### get counts for many
POST {{host}}/api/v1/counts?site=remark
@@ -68,7 +68,7 @@ Content-Type: application/json
[
"https://radio-t.com/p/2017/12/02/podcast-574/",
"https://radio-t.com/p/2017/12/09/podcast-575/",
"https://radio-t.com/p/2017/12/16/podcast-576/"
"https://remark42.com/demo/"
]
### list commented posts
@@ -87,16 +87,14 @@ PUT {{host}}/api/v1/admin/user/disqus_grigorybakunov?site=remark&block=0
GET {{host}}/api/v1/admin/blocked?site=remark
### delete comment by id
DELETE {{host}}/api/v1/admin/comment/3665976683?site=remark&url=https://radio-t.com/p/2017/12/16/podcast-576/
DELETE {{host}}/api/v1/admin/comment/3665976683?site=remark&url=https://remark42.com/demo/
### subscribe
PUT {{host}}/api/v1/notify?site=remark&url=https://radio-t.com/p/2017/12/16/podcast-576/&action=1
### unsubscribe
PUT {{host}}/api/v1/notify?site=remark&url=https://radio-t.com/p/2017/12/16/podcast-576/&action=0
### post rss
GET {{host}}/api/v1/rss/post?site=remark&url=https://remark42.com/demo/
### subscribtion status
GET {{host}}/api/v1/notify?site=remark&url=https://radio-t.com/p/2017/12/16/podcast-576/
### site rss
PUT {{host}}/api/v1/rss/site?site=remark
### get default avatar
GET {{host}}/api/v1/avatar/blah