mirror of
https://github.com/versia-pub/docs.git
synced 2025-12-06 06:18:19 +01:00
feat: ✨ Add Reports
This commit is contained in:
parent
7189a6f411
commit
ac96922bd3
53
app/extensions/reports/page.mdx
Normal file
53
app/extensions/reports/page.mdx
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
export const metadata = {
|
||||
"title": "Reports Extension",
|
||||
"description": "Reporting can be used to report content to moderators or administrators of a remote instance for review."
|
||||
}
|
||||
|
||||
# Reports Extension
|
||||
|
||||
Reporting can be used to report content to moderators or administrators of a remote instance for review. {{ className: 'lead' }}
|
||||
|
||||
When an instance receives a report, it *should* be reviewed by a moderator or administrator.
|
||||
|
||||
## Entity Definition
|
||||
|
||||
<Row>
|
||||
<Col>
|
||||
<Properties>
|
||||
<Property name="type" type="string" required={true}>
|
||||
Must be `pub.versia:reports/Report`.
|
||||
</Property>
|
||||
<Property name="author" type="URI" required={false} typeLink="/types#uri">
|
||||
URI of the reporting [User](/entities/user). Optional if the report is anonymous.
|
||||
</Property>
|
||||
<Property name="reported" type="URI[]" required={true} typeLink="/types#uri">
|
||||
URIs of the content being reported.
|
||||
</Property>
|
||||
<Property name="reason" type="string" required={true}>
|
||||
Reason for the report. Should be concise and clear, such as `spam`, `harassment`, `misinformation`, etc.
|
||||
</Property>
|
||||
<Property name="comment" type="string" required={false}>
|
||||
Additional comments about the report. Can be used to provide more context or details.
|
||||
</Property>
|
||||
</Properties>
|
||||
</Col>
|
||||
|
||||
<Col sticky>
|
||||
|
||||
```jsonc {{ title: "Example Report" }}
|
||||
{
|
||||
"id": "6f3001a1-641b-4763-a9c4-a089852eec84",
|
||||
"type": "pub.versia:reports/Report",
|
||||
"author": "https://example.com/users/6f3001a1-641b-4763-a9c4-a089852eec84",
|
||||
"uri": "https://example.com/reports/f7bbf7fc-88d2-47dd-b241-5d1f770a10f0",
|
||||
"reported": [
|
||||
"https://test.com/publications/46f936a3-9a1e-4b02-8cde-0902a89769fa",
|
||||
"https://test.com/publications/213d7c56-fb9b-4646-a4d2-7d70aa7d106a"
|
||||
],
|
||||
"reason": "spam",
|
||||
"comment": "This is spam."
|
||||
}
|
||||
```
|
||||
|
||||
</Col>
|
||||
</Row>
|
||||
|
|
@ -292,6 +292,7 @@ export const navigation: NavGroup[] = [
|
|||
{ title: "Likes", href: "/extensions/likes" },
|
||||
{ title: "Polls", href: "/extensions/polls" },
|
||||
{ title: "Reactions", href: "/extensions/reactions" },
|
||||
{ title: "Reports", href: "/extensions/reports" },
|
||||
{ title: "Share", href: "/extensions/share" },
|
||||
{ title: "Vanity", href: "/extensions/vanity" },
|
||||
{ title: "WebSockets", href: "/extensions/websockets" },
|
||||
|
|
|
|||
Loading…
Reference in a new issue