versia-pub/docs
2
0
Fork 0
mirror of https://github.com/versia-pub/docs.git synced 2025-12-06 14:28:20 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

refactor: ♻️ Improve Reports entity

Browse source
This commit is contained in:
Jesse Wierzbinski 2024-09-28 21:43:17 +02:00
parent 8794d00853
commit 842e842e3c
No known key found for this signature in database
1 changed files with 9 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
app/extensions/reports/page.mdx
View file

@ -14,6 +14,9 @@ When an instance receives a report, it *should* be reviewed by a moderator or ad
<Row> <Row>
<Col> <Col>
<Properties> <Properties>
<Property name="uri" type="null" required={false}>
This entity does not have a URI.
</Property>
<Property name="type" type="string" required={true}> <Property name="type" type="string" required={true}>
Must be `pub.versia:reports/Report`. Must be `pub.versia:reports/Report`.
</Property> </Property>
@ -23,8 +26,8 @@ When an instance receives a report, it *should* be reviewed by a moderator or ad
<Property name="reported" type="URI[]" required={true} typeLink="/types#uri"> <Property name="reported" type="URI[]" required={true} typeLink="/types#uri">
URIs of the content being reported. URIs of the content being reported.
</Property> </Property>
<Property name="reason" type="string" required={true}> <Property name="tags" type="string[]" required={true}>
Reason for the report. Should be concise and clear, such as `spam`, `harassment`, `misinformation`, etc. Report tags. Should be concise and clear, such as `spam`, `harassment`, `misinformation`, etc. Used for categorization.
</Property> </Property>
<Property name="comment" type="string" required={false}> <Property name="comment" type="string" required={false}>
Additional comments about the report. Can be used to provide more context or details. Additional comments about the report. Can be used to provide more context or details.
@ -39,12 +42,14 @@ When an instance receives a report, it *should* be reviewed by a moderator or ad
"id": "6f3001a1-641b-4763-a9c4-a089852eec84", "id": "6f3001a1-641b-4763-a9c4-a089852eec84",
"type": "pub.versia:reports/Report", "type": "pub.versia:reports/Report",
"author": "https://example.com/users/6f3001a1-641b-4763-a9c4-a089852eec84", "author": "https://example.com/users/6f3001a1-641b-4763-a9c4-a089852eec84",
"uri": "https://example.com/reports/f7bbf7fc-88d2-47dd-b241-5d1f770a10f0",
"reported": [ "reported": [
"https://test.com/publications/46f936a3-9a1e-4b02-8cde-0902a89769fa", "https://test.com/publications/46f936a3-9a1e-4b02-8cde-0902a89769fa",
"https://test.com/publications/213d7c56-fb9b-4646-a4d2-7d70aa7d106a" "https://test.com/publications/213d7c56-fb9b-4646-a4d2-7d70aa7d106a"
], ],
"reason": "spam", "tags": [
"spam",
"harassment"
],
"comment": "This is spam." "comment": "This is spam."
} }
``` ```