From 1954d2b67fa0d6dc1e629eabb5c27e3d1eef37cb Mon Sep 17 00:00:00 2001 From: Dessalines Date: Sat, 7 Sep 2019 08:18:52 -0700 Subject: Updating translation report, adding some new lines in api docs. --- docs/api.md | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'docs') diff --git a/docs/api.md b/docs/api.md index dc558c96..871b20e2 100644 --- a/docs/api.md +++ b/docs/api.md @@ -2,6 +2,7 @@ *Note: this may lag behind the actual API endpoints [here](../server/src/api).* ## Data types + - `i16`, `i32` and `i64` are respectively [16-bit](https://en.wikipedia.org/wiki/16-bit), [32-bit](https://en.wikipedia.org/wiki/32-bit) and [64-bit](https://en.wikipedia.org/wiki/64-bit_computing) integers. - Option<***SomeType***> designates an option which may be omitted in requests and not be present in responses. It will be of type ***SomeType***. - Vec<***SomeType***> is a list which contains objects of type ***SomeType***. @@ -9,9 +10,11 @@ - Other data types are listed [here](../server/src/db). ## Basic usage + Request and response strings are in [JSON format](https://www.json.org). ### Endpoint + Connect to ws://***host***/api/v1/ws to get started. If the ***`host`*** supports secure connections, you can use wss://***host***/api/v1/ws. @@ -34,6 +37,7 @@ ws.onopen = function () { ``` ## Rate limits + - 1 per hour for signups and community creation. - 1 per 10 minutes for post creation. - 30 actions per minute for post voting and comment creation. @@ -48,7 +52,9 @@ ws.onopen = function () { ``` ## API documentation + ### Sort Types + These go wherever there is a `sort` field. The available sort types are: - `Hot` - the hottest posts/communities, depending on votes, views, comments and publish date @@ -60,7 +66,9 @@ These go wherever there is a `sort` field. The available sort types are: - `TopAll` - the most upvoted posts/communities on the current instance. ### User / Authentication / Admin actions + #### Login + The `jwt` string should be stored and used anywhere `auth` is called for. ##### Request -- cgit v1.2.3