diff options
| author | Dessalines <tyhou13@gmx.com> | 2019-12-06 21:09:59 -0800 |
|---|---|---|
| committer | Dessalines <tyhou13@gmx.com> | 2019-12-06 21:09:59 -0800 |
| commit | b63878d306bc9c3e13f3b673a3ef059401b8c8b0 (patch) | |
| tree | a0015c54b40f1e077772c9326f2156d05e161c38 /docs | |
| parent | ab53840324d252ebb5e89f14ecbe1d55aa56c85a (diff) | |
Adding API docs for RSS feeds.
- Fixes #348
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api.md | 25 |
1 files changed, 22 insertions, 3 deletions
diff --git a/docs/api.md b/docs/api.md index f31fb60d..16383d53 100644 --- a/docs/api.md +++ b/docs/api.md @@ -1,11 +1,11 @@ -# Lemmy WebSocket API +# Lemmy API *Note: this may lag behind the actual API endpoints [here](../server/src/api).* <!-- toc --> - [Data types](#data-types) - [Basic usage](#basic-usage) - * [Endpoint](#endpoint) + * [WebSocket Endpoint](#websocket-endpoint) * [Testing with Websocat](#testing-with-websocat) * [Testing with the WebSocket JavaScript API](#testing-with-the-websocket-javascript-api) - [Rate limits](#rate-limits) @@ -125,6 +125,10 @@ + [Create Comment Like](#create-comment-like) - [Request](#request-35) - [Response](#response-35) + * [RSS / Atom feeds](#rss--atom-feeds) + + [All](#all) + + [Community](#community-1) + + [User](#user) <!-- tocstop --> @@ -140,7 +144,7 @@ Request and response strings are in [JSON format](https://www.json.org). -### Endpoint +### WebSocket Endpoint Connect to <code>ws://***host***/api/v1/ws</code> to get started. @@ -1010,3 +1014,18 @@ Mods and admins can remove a comment, creators can delete it. comment: CommentView } ``` + +### RSS / Atom feeds + +#### All + +`/feeds/all.xml?sort=Hot` + +#### Community + +`/feeds/c/community-name.xml?sort=Hot` + +#### User + +`/feeds/u/user-name.xml?sort=Hot` + |