From: Dessalines Date: Sat, 7 Sep 2019 15:18:52 +0000 (-0700) Subject: Updating translation report, adding some new lines in api docs. X-Git-Url: http://these/git/readmes/%7B%60%24%7BarchiveTodayUrl%7D/static/gitweb.js?a=commitdiff_plain;h=1954d2b67fa0d6dc1e629eabb5c27e3d1eef37cb;p=lemmy.git Updating translation report, adding some new lines in api docs. --- diff --git a/README.md b/README.md index 79511352..155d9b08 100644 --- a/README.md +++ b/README.md @@ -169,14 +169,14 @@ If you'd like to add translations, take a look a look at the [english translatio lang | done | missing --- | --- | --- -de | 87% | cross_posts,cross_post,users,number_of_communities,preview,upload_image,formatting_help,settings,subscribed,expires,recent_comments,nsfw,show_nsfw,crypto,monero,joined,by,to,transfer_community,transfer_site,are_you_sure,yes,no -eo | 96% | number_of_communities,preview,upload_image,formatting_help,are_you_sure,yes,no -es | 96% | number_of_communities,preview,upload_image,formatting_help,are_you_sure,yes,no -fr | 100% | -nl | 98% | preview,upload_image,formatting_help -ru | 91% | cross_posts,cross_post,number_of_communities,preview,upload_image,formatting_help,recent_comments,monero,by,to,transfer_community,transfer_site,are_you_sure,yes,no -sv | 98% | preview,upload_image,formatting_help -zh | 89% | cross_posts,cross_post,users,number_of_communities,preview,upload_image,formatting_help,settings,recent_comments,nsfw,show_nsfw,monero,by,to,transfer_community,transfer_site,are_you_sure,yes,no +de | 86% | cross_posts,cross_post,users,number_of_communities,preview,upload_image,formatting_help,settings,banned,subscribed,expires,recent_comments,nsfw,show_nsfw,crypto,monero,joined,by,to,transfer_community,transfer_site,are_you_sure,yes,no +eo | 95% | number_of_communities,preview,upload_image,formatting_help,banned,are_you_sure,yes,no +es | 95% | number_of_communities,preview,upload_image,formatting_help,banned,are_you_sure,yes,no +fr | 100% | +nl | 98% | preview,upload_image,formatting_help,banned +ru | 91% | cross_posts,cross_post,number_of_communities,preview,upload_image,formatting_help,banned,recent_comments,monero,by,to,transfer_community,transfer_site,are_you_sure,yes,no +sv | 98% | preview,upload_image,formatting_help,banned +zh | 89% | cross_posts,cross_post,users,number_of_communities,preview,upload_image,formatting_help,settings,banned,recent_comments,nsfw,show_nsfw,monero,by,to,transfer_community,transfer_site,are_you_sure,yes,no ## Credits 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