-
-
Notifications
You must be signed in to change notification settings - Fork 978
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation for
moderation_warning
notification types (#1479)
* Add documentation for `moderation_warning` notification types * Add documentation for `AccountWarning` entity * Add documentation for `Appeal` entity
- Loading branch information
1 parent
db089a9
commit e19829b
Showing
3 changed files
with
108 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
--- | ||
title: AccountWarning | ||
description: Moderation warning against a particular account. | ||
menu: | ||
docs: | ||
parent: entities | ||
aliases: [ | ||
"/entities/AccountWarning", | ||
"/api/entities/AccountWarning", | ||
] | ||
--- | ||
|
||
## Attributes | ||
|
||
### `id` {#id} | ||
|
||
**Description:** The ID of the account warning in the database.\ | ||
**Type:** String (cast from integer)\ | ||
**Version history:**\ | ||
4.3.0 - added | ||
|
||
### `action` {#action} | ||
|
||
**Description:** Action taken against the account.\ | ||
**Type:** String (Enumerable oneOf)\ | ||
`none` = No action was taken, this is a simple warning\ | ||
`disable` = The account has been disabled\ | ||
`mark_statuses_as_sensitive` = Specific posts from the target account have been marked as sensitive\ | ||
`delete_statuses` = Specific statuses from the target account have been deleted\ | ||
`sensitive` = All posts from the target account are marked as sensitive\ | ||
`silence` = The target account has been limited\ | ||
`suspend` = The target account has been suspended\ | ||
**Version history:**\ | ||
4.3.0 - added | ||
|
||
### `text` {#text} | ||
|
||
**Description:** Message from the moderator to the target account.\ | ||
**Type:** String\ | ||
**Version history:**\ | ||
4.3.0 - added | ||
|
||
### `status_ids` {#status_ids} | ||
|
||
**Description:** List of status IDs that are relevant to the warning. When `action` is `mark_statuses_as_sensitive` or `delete_statuses`, those are the affected statuses.\ | ||
**Type:** Array of String (cast from integer)\ | ||
**Version history:**\ | ||
4.3.0 - added | ||
|
||
### `target_account` {#target_account} | ||
|
||
**Description:** Account against which a moderation decision has been taken.\ | ||
**Type:** [Account]({{< relref "entities/Account" >}})\ | ||
**Version history:**\ | ||
4.3.0 - added | ||
|
||
### `appeal` {#appeal} | ||
|
||
**Description:** Appeal submitted by the target account, if any.\ | ||
**Type:** {{<nullable>}} [Appeal]({{< relref "entities/Appeal" >}}), or null\ | ||
**Version history:**\ | ||
4.3.0 - added | ||
|
||
### `created_at` {#created_at} | ||
|
||
**Description:** When the event took place.\ | ||
**Type:** String (ISO 8601 Datetime)\ | ||
**Version history:**\ | ||
4.3.0 - added |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
--- | ||
title: Appeal | ||
description: Appeal against a moderation action. | ||
menu: | ||
docs: | ||
parent: entities | ||
aliases: [ | ||
"/entities/Appeal", | ||
"/api/entities/Appeal", | ||
] | ||
--- | ||
|
||
## Attributes | ||
|
||
### `text` {#text} | ||
|
||
**Description:** Text of the appeal from the moderated account to the moderators.\ | ||
**Type:** String\ | ||
**Version history:**\ | ||
4.3.0 - added | ||
|
||
### `state` {#state} | ||
|
||
**Description:** State of the appeal.\ | ||
**Type:** String (Enumerable oneOf)\ | ||
`approved` = The appeal has been approved by a moderator\ | ||
`rejected` = The appeal has been rejected by a moderator\ | ||
`pending` = The appeal has been submitted, but neither approved nor rejected yet\ | ||
**Version history:**\ | ||
4.3.0 - added |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters