Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in
Toggle navigation
D
docs
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
21
Issues
21
List
Board
Labels
Milestones
Merge Requests
19
Merge Requests
19
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
mastodon
docs
Commits
7d449509
Commit
7d449509
authored
Oct 05, 2018
by
Eugen Rochko
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Improve blocks, mutes and endorsements APIs
parent
7f4e00e4
Pipeline
#307
passed with stages
in 17 seconds
Changes
3
Pipelines
1
Show whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
68 additions
and
2 deletions
+68
-2
blocks.md
content/en/api/rest/blocks.md
+21
-1
endorsements.md
content/en/api/rest/endorsements.md
+20
-0
mutes.md
content/en/api/rest/mutes.md
+27
-1
No files found.
content/en/api/rest/blocks.md
View file @
7d449509
...
...
@@ -14,7 +14,7 @@ Returns array of [Account]({{< relref "entities.md#account" >}})
### Resource information
{{
<
api
_method_info
auth=
"Yes"
user=
"Yes"
scope=
"read
read
:blocks follow"
version=
"0.0.0"
>
}}
{{
<
api
_method_info
auth=
"Yes"
user=
"Yes"
scope=
"read:blocks follow"
version=
"0.0.0"
>
}}
### Parameters
...
...
@@ -25,3 +25,23 @@ Returns array of [Account]({{< relref "entities.md#account" >}})
### Pagination
{{
<
api
_pagination
>
}}
## POST /api/v1/accounts/:id/block
Block an account.
Returns
[
Relationship
](
{{
<
relref
"
entities
.
md
#
relationship
"
>
}})
### Resource information
{{
<
api
_method_info
auth=
"Yes"
user=
"Yes"
scope=
"write:blocks follow"
version=
"0.0.0"
>
}}
## POST /api/v1/accounts/:id/unblock
Unblock an account.
Returns
[
Relationship
](
{{
<
relref
"
entities
.
md
#
relationship
"
>
}})
### Resource information
{{
<
api
_method_info
auth=
"Yes"
user=
"Yes"
scope=
"write:blocks follow"
version=
"0.0.0"
>
}}
content/en/api/rest/endorsements.md
View file @
7d449509
...
...
@@ -19,3 +19,23 @@ Returns array of [Account]({{< relref "entities.md#account" >}})
### Pagination
{{
<
api
_pagination
>
}}
## POST /api/v1/accounts/:id/pin
Endorse an account, i.e. choose to feature the account on the user's public profile.
Returns
[
Relationship
](
{{
<
relref
"
entities
.
md
#
relationship
"
>
}})
### Resource information
{{
<
api
_method_info
auth=
"Yes"
user=
"Yes"
scope=
"write write:accounts"
version=
"0.0.0"
>
}}
## POST /api/v1/accounts/:id/unpin
Undo endorse of an account.
Returns
[
Relationship
](
{{
<
relref
"
entities
.
md
#
relationship
"
>
}})
### Resource information
{{
<
api
_method_info
auth=
"Yes"
user=
"Yes"
scope=
"write write:accounts"
version=
"0.0.0"
>
}}
content/en/api/rest/mutes.md
View file @
7d449509
...
...
@@ -14,7 +14,7 @@ Returns array of [Account]({{< relref "entities.md#account" >}})
### Resource information
{{
<
api
_method_info
auth=
"Yes"
user=
"Yes"
scope=
"read
read
:mutes follow"
version=
"0.0.0"
>
}}
{{
<
api
_method_info
auth=
"Yes"
user=
"Yes"
scope=
"read:mutes follow"
version=
"0.0.0"
>
}}
### Parameters
...
...
@@ -25,3 +25,29 @@ Returns array of [Account]({{< relref "entities.md#account" >}})
### Pagination
{{
<
api
_pagination
>
}}
## POST /api/v1/accounts/:id/mute
Mute an account.
Returns
[
Relationship
](
{{
<
relref
"
entities
.
md
#
relationship
"
>
}})
### Resource information
{{
<
api
_method_info
auth=
"Yes"
user=
"Yes"
scope=
"write:mutes follow"
version=
"0.0.0"
>
}}
### Parameters
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
|
`notifications`
| Whether the mute will mute notifications or not | Optional | true |
## POST /api/v1/accounts/:id/unmute
Unmute an account.
Returns
[
Relationship
](
{{
<
relref
"
entities
.
md
#
relationship
"
>
}})
### Resource information
{{
<
api
_method_info
auth=
"Yes"
user=
"Yes"
scope=
"write:mutes follow"
version=
"0.0.0"
>
}}
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment