From 884703fd6cfb076366d2c67661235ec7fe79db14 Mon Sep 17 00:00:00 2001
From: Eugen Rochko <eugen@zeonfederated.com>
Date: Fri, 5 Oct 2018 01:37:50 +0200
Subject: [PATCH] Add more descriptions

---
 content/en/api/rest/apps.md               |  2 ++
 content/en/api/rest/blocks.md             |  2 ++
 content/en/api/rest/custom-emojis.md      |  2 ++
 content/en/api/rest/endorsements.md       |  2 ++
 content/en/api/rest/favourites.md         |  2 ++
 content/en/api/rest/follow-suggestions.md | 18 ++++++++++++++++++
 content/en/api/rest/instances.md          |  2 ++
 content/en/api/rest/mutes.md              |  2 ++
 content/en/api/rest/reports.md            |  3 +++
 content/en/api/rest/timelines.md          |  8 ++++++++
 10 files changed, 43 insertions(+)

diff --git a/content/en/api/rest/apps.md b/content/en/api/rest/apps.md
index 9d0817ef..656c8558 100644
--- a/content/en/api/rest/apps.md
+++ b/content/en/api/rest/apps.md
@@ -8,6 +8,8 @@ menu:
 
 ## POST /api/v1/apps
 
+Create a new application to obtain OAuth2 credentials.
+
 Returns [App]({{< relref "entities.md#app" >}}) with `client_id` and `client_secret`
 
 ### Resource information
diff --git a/content/en/api/rest/blocks.md b/content/en/api/rest/blocks.md
index e3b1016c..2a71fcb6 100644
--- a/content/en/api/rest/blocks.md
+++ b/content/en/api/rest/blocks.md
@@ -8,6 +8,8 @@ menu:
 
 ## GET /api/v1/blocks
 
+Accounts the user has blocked.
+
 Returns array of [Account]({{< relref "entities.md#account" >}})
 
 ### Resource information
diff --git a/content/en/api/rest/custom-emojis.md b/content/en/api/rest/custom-emojis.md
index efd36167..07664c0b 100644
--- a/content/en/api/rest/custom-emojis.md
+++ b/content/en/api/rest/custom-emojis.md
@@ -8,6 +8,8 @@ menu:
 
 ## GET /api/v1/custom_emojis
 
+Custom emojis that are available on the server.
+
 Returns array of [Emoji]({{< relref "entities.md#emoji" >}})
 
 ### Resource information
diff --git a/content/en/api/rest/endorsements.md b/content/en/api/rest/endorsements.md
index 6ed2434a..3df6ee87 100644
--- a/content/en/api/rest/endorsements.md
+++ b/content/en/api/rest/endorsements.md
@@ -8,6 +8,8 @@ menu:
 
 ## GET /api/v1/endorsements
 
+Accounts the user chose to endorse.
+
 Returns array of [Account]({{< relref "entities.md#account" >}})
 
 ### Resource information
diff --git a/content/en/api/rest/favourites.md b/content/en/api/rest/favourites.md
index 9e9c32ca..e1c92d11 100644
--- a/content/en/api/rest/favourites.md
+++ b/content/en/api/rest/favourites.md
@@ -8,6 +8,8 @@ menu:
 
 ## GET /api/v1/favourites
 
+Statuses the user has favourited.
+
 Returns array of [Status]({{< relref "entities.md#status" >}})
 
 ### Resource information
diff --git a/content/en/api/rest/follow-suggestions.md b/content/en/api/rest/follow-suggestions.md
index 789a9897..49b2dca6 100644
--- a/content/en/api/rest/follow-suggestions.md
+++ b/content/en/api/rest/follow-suggestions.md
@@ -5,3 +5,21 @@ menu:
     parent: api
     weight: 10
 ---
+
+## GET /api/v1/suggestions
+
+Accounts the user had past positive interactions with, but is not following yet.
+
+Returns array of [Account]({{< relref "entities.md#account" >}})
+
+### Resource information
+
+{{< api_method_info auth="Yes" user="Yes" scope="read" version="0.0.0" >}}
+
+## DELETE /api/v1/suggestions/:account_id
+
+Remove account from suggestions.
+
+### Resource information
+
+{{< api_method_info auth="Yes" user="Yes" scope="read" version="0.0.0" >}}
diff --git a/content/en/api/rest/instances.md b/content/en/api/rest/instances.md
index 5d639845..d40d8e05 100644
--- a/content/en/api/rest/instances.md
+++ b/content/en/api/rest/instances.md
@@ -8,6 +8,8 @@ menu:
 
 ## GET /api/v1/instance
 
+Information about the server.
+
 Returns [Instance]({{< relref "entities.md#instance" >}})
 
 ### Resource information
diff --git a/content/en/api/rest/mutes.md b/content/en/api/rest/mutes.md
index 59d15b28..f9fd4f4b 100644
--- a/content/en/api/rest/mutes.md
+++ b/content/en/api/rest/mutes.md
@@ -8,6 +8,8 @@ menu:
 
 ## GET /api/v1/mutes
 
+Accounts the user has muted.
+
 Returns array of [Account]({{< relref "entities.md#account" >}})
 
 ### Resource information
diff --git a/content/en/api/rest/reports.md b/content/en/api/rest/reports.md
index 3e5d9dd9..a4cacb15 100644
--- a/content/en/api/rest/reports.md
+++ b/content/en/api/rest/reports.md
@@ -7,6 +7,9 @@ menu:
 ---
 
 ## POST /api/v1/reports
+
+Report an account.
+
 ### Resource information
 
 {{< api_method_info auth="Yes" user="Yes" scope="write write:reports" version="0.0.0" >}}
diff --git a/content/en/api/rest/timelines.md b/content/en/api/rest/timelines.md
index 81d020f8..134a511e 100644
--- a/content/en/api/rest/timelines.md
+++ b/content/en/api/rest/timelines.md
@@ -8,6 +8,8 @@ menu:
 
 ## GET /api/v1/timelines/home
 
+Statuses from accounts the user follows.
+
 Returns array of [Status]({{< relref "entities.md#status" >}})
 
 ### Resource information
@@ -28,6 +30,8 @@ Returns array of [Status]({{< relref "entities.md#status" >}})
 
 ## GET /api/v1/timelines/public
 
+Public statuses known to the server.
+
 Returns array of [Status]({{< relref "entities.md#status" >}})
 
 ### Resource information
@@ -50,6 +54,8 @@ Returns array of [Status]({{< relref "entities.md#status" >}})
 
 ## GET /api/v1/timelines/tag/:hashtag
 
+Public statuses known to the server marked with a given hashtag.
+
 Returns array of [Status]({{< relref "entities.md#status" >}})
 
 ### Resource information
@@ -72,6 +78,8 @@ Returns array of [Status]({{< relref "entities.md#status" >}})
 
 ## GET /api/v1/timelines/list/:list_id
 
+Statuses from accounts on a given list.
+
 Returns array of [Status]({{< relref "entities.md#status" >}})
 
 ### Resource information