From b63878d306bc9c3e13f3b673a3ef059401b8c8b0 Mon Sep 17 00:00:00 2001 From: Dessalines Date: Fri, 6 Dec 2019 21:09:59 -0800 Subject: [PATCH] Adding API docs for RSS feeds. - Fixes #348 --- docs/api.md | 25 ++++++++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/docs/api.md b/docs/api.md index f31fb60d2..16383d532 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).* - [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) @@ -140,7 +144,7 @@ Request and response strings are in [JSON format](https://www.json.org). -### Endpoint +### WebSocket Endpoint Connect to ws://***host***/api/v1/ws 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` +