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

<Warning>
    This entity is a [**Transient Entity**](/entities#transient-entities).
</Warning>

<Row>
    <Col>
        <Properties name="Report">
            <Property name="type" type="string" required={true}>
                Must be `pub.versia:reports/Report`.
            </Property>
            <Property name="author" type="Reference" required={false} typeLink="/types#reference">
                [Reference](/types#reference) to the reporting [User](/entities/user). Optional if the report is anonymous.
            </Property>
            <Property name="reported" type="Reference[]" required={true} typeLink="/types#reference">
                [References](/types#reference) to the content being reported.
            </Property>
            <Property name="tags" type="string[]" required={true}>
                Report tags. Should be concise and clear, such as `spam`, `harassment`, `misinformation`, etc. Used for categorization.
            </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" }}
    {
        "type": "pub.versia:reports/Report",
        "author": "6f3001a1-641b-4763-a9c4-a089852eec84",
        "reported": [
            "test.com:46f936a3-9a1e-4b02-8cde-0902a89769fa",
            "test.com:213d7c56-fb9b-4646-a4d2-7d70aa7d106a"
        ],
        "tags": [
            "spam",
            "harassment"
        ],
        "comment": "This is spam."
    }
    ```

    </Col>
</Row>