Commit 884703fd authored by Eugen Rochko's avatar Eugen Rochko

Add more descriptions

parent 9ded5dbb
Pipeline #302 passed with stages
in 17 seconds
...@@ -8,6 +8,8 @@ menu: ...@@ -8,6 +8,8 @@ menu:
## POST /api/v1/apps ## POST /api/v1/apps
Create a new application to obtain OAuth2 credentials.
Returns [App]({{< relref "entities.md#app" >}}) with `client_id` and `client_secret` Returns [App]({{< relref "entities.md#app" >}}) with `client_id` and `client_secret`
### Resource information ### Resource information
......
...@@ -8,6 +8,8 @@ menu: ...@@ -8,6 +8,8 @@ menu:
## GET /api/v1/blocks ## GET /api/v1/blocks
Accounts the user has blocked.
Returns array of [Account]({{< relref "entities.md#account" >}}) Returns array of [Account]({{< relref "entities.md#account" >}})
### Resource information ### Resource information
......
...@@ -8,6 +8,8 @@ menu: ...@@ -8,6 +8,8 @@ menu:
## GET /api/v1/custom_emojis ## GET /api/v1/custom_emojis
Custom emojis that are available on the server.
Returns array of [Emoji]({{< relref "entities.md#emoji" >}}) Returns array of [Emoji]({{< relref "entities.md#emoji" >}})
### Resource information ### Resource information
......
...@@ -8,6 +8,8 @@ menu: ...@@ -8,6 +8,8 @@ menu:
## GET /api/v1/endorsements ## GET /api/v1/endorsements
Accounts the user chose to endorse.
Returns array of [Account]({{< relref "entities.md#account" >}}) Returns array of [Account]({{< relref "entities.md#account" >}})
### Resource information ### Resource information
......
...@@ -8,6 +8,8 @@ menu: ...@@ -8,6 +8,8 @@ menu:
## GET /api/v1/favourites ## GET /api/v1/favourites
Statuses the user has favourited.
Returns array of [Status]({{< relref "entities.md#status" >}}) Returns array of [Status]({{< relref "entities.md#status" >}})
### Resource information ### Resource information
......
...@@ -5,3 +5,21 @@ menu: ...@@ -5,3 +5,21 @@ menu:
parent: api parent: api
weight: 10 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" >}}
...@@ -8,6 +8,8 @@ menu: ...@@ -8,6 +8,8 @@ menu:
## GET /api/v1/instance ## GET /api/v1/instance
Information about the server.
Returns [Instance]({{< relref "entities.md#instance" >}}) Returns [Instance]({{< relref "entities.md#instance" >}})
### Resource information ### Resource information
......
...@@ -8,6 +8,8 @@ menu: ...@@ -8,6 +8,8 @@ menu:
## GET /api/v1/mutes ## GET /api/v1/mutes
Accounts the user has muted.
Returns array of [Account]({{< relref "entities.md#account" >}}) Returns array of [Account]({{< relref "entities.md#account" >}})
### Resource information ### Resource information
......
...@@ -7,6 +7,9 @@ menu: ...@@ -7,6 +7,9 @@ menu:
--- ---
## POST /api/v1/reports ## POST /api/v1/reports
Report an account.
### Resource information ### Resource information
{{< api_method_info auth="Yes" user="Yes" scope="write write:reports" version="0.0.0" >}} {{< api_method_info auth="Yes" user="Yes" scope="write write:reports" version="0.0.0" >}}
......
...@@ -8,6 +8,8 @@ menu: ...@@ -8,6 +8,8 @@ menu:
## GET /api/v1/timelines/home ## GET /api/v1/timelines/home
Statuses from accounts the user follows.
Returns array of [Status]({{< relref "entities.md#status" >}}) Returns array of [Status]({{< relref "entities.md#status" >}})
### Resource information ### Resource information
...@@ -28,6 +30,8 @@ Returns array of [Status]({{< relref "entities.md#status" >}}) ...@@ -28,6 +30,8 @@ Returns array of [Status]({{< relref "entities.md#status" >}})
## GET /api/v1/timelines/public ## GET /api/v1/timelines/public
Public statuses known to the server.
Returns array of [Status]({{< relref "entities.md#status" >}}) Returns array of [Status]({{< relref "entities.md#status" >}})
### Resource information ### Resource information
...@@ -50,6 +54,8 @@ Returns array of [Status]({{< relref "entities.md#status" >}}) ...@@ -50,6 +54,8 @@ Returns array of [Status]({{< relref "entities.md#status" >}})
## GET /api/v1/timelines/tag/:hashtag ## 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" >}}) Returns array of [Status]({{< relref "entities.md#status" >}})
### Resource information ### Resource information
...@@ -72,6 +78,8 @@ Returns array of [Status]({{< relref "entities.md#status" >}}) ...@@ -72,6 +78,8 @@ Returns array of [Status]({{< relref "entities.md#status" >}})
## GET /api/v1/timelines/list/:list_id ## GET /api/v1/timelines/list/:list_id
Statuses from accounts on a given list.
Returns array of [Status]({{< relref "entities.md#status" >}}) Returns array of [Status]({{< relref "entities.md#status" >}})
### Resource information ### Resource information
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment