mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-04-23 19:24:10 +02:00
Compare commits
1 commit
d9636b2566
...
52bbf2606f
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
52bbf2606f |
|
|
@ -1 +0,0 @@
|
||||||
Add `POST /_matrix/client/v3/users/{userId}/report` as per [MSC4260](https://github.com/matrix-org/matrix-spec-proposals/pull/4260).
|
|
||||||
|
|
@ -29,9 +29,3 @@ is in before accepting a report.
|
||||||
based on whether or not the reporting user is joined to the room. This is
|
based on whether or not the reporting user is joined to the room. This is
|
||||||
because users can be exposed to harmful content without being joined to a
|
because users can be exposed to harmful content without being joined to a
|
||||||
room. For instance, through room directories or invites.
|
room. For instance, through room directories or invites.
|
||||||
|
|
||||||
{{% added-in v="1.14" %}} Similarly, servers MUST NOT restrict user reports
|
|
||||||
based on whether or not the reporting user is joined to any rooms that the
|
|
||||||
reported user is joined to. This is because users can be exposed to harmful
|
|
||||||
content without being joined to a room. For instance, through user
|
|
||||||
directories or invites.
|
|
||||||
|
|
|
||||||
|
|
@ -45,9 +45,7 @@ paths:
|
||||||
properties:
|
properties:
|
||||||
reason:
|
reason:
|
||||||
type: string
|
type: string
|
||||||
description: The reason the room is being reported. May be blank.
|
description: The reason the room is being reported.
|
||||||
required:
|
|
||||||
- reason
|
|
||||||
required: true
|
required: true
|
||||||
security:
|
security:
|
||||||
- accessTokenQuery: []
|
- accessTokenQuery: []
|
||||||
|
|
@ -90,11 +88,12 @@ paths:
|
||||||
Reports an event as inappropriate to the server, which may then notify
|
Reports an event as inappropriate to the server, which may then notify
|
||||||
the appropriate people. The caller must be joined to the room to report
|
the appropriate people. The caller must be joined to the room to report
|
||||||
it.
|
it.
|
||||||
|
|
||||||
Furthermore, it might be possible for clients to deduce whether a reported
|
It might be possible for clients to deduce whether an event exists by
|
||||||
event exists by timing the response. This is because only a report for an
|
timing the response, as only a report for an event that does exist
|
||||||
existing event will require the homeserver to do further processing. To
|
will require the homeserver to check whether a user is joined to
|
||||||
combat this, homeservers MAY add a random delay when generating a response.
|
the room. To combat this, homeserver implementations should add
|
||||||
|
a random delay when generating a response.
|
||||||
operationId: reportEvent
|
operationId: reportEvent
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
|
|
@ -165,88 +164,6 @@ paths:
|
||||||
}
|
}
|
||||||
tags:
|
tags:
|
||||||
- Reporting content
|
- Reporting content
|
||||||
"/users/{userId}/report":
|
|
||||||
post:
|
|
||||||
x-addedInMatrixVersion: "1.14"
|
|
||||||
summary: Report a user as inappropriate.
|
|
||||||
description: |-
|
|
||||||
Reports a user as inappropriate to the server, which may then notify
|
|
||||||
the appropriate people. How such information is delivered is left up to
|
|
||||||
implementations. The caller is not required to be joined to any rooms
|
|
||||||
that the reported user is joined to.
|
|
||||||
|
|
||||||
Clients may wish to [ignore](#ignoring-users) users after reporting them.
|
|
||||||
|
|
||||||
Clients could infer whether a reported user exists based on the 404 response.
|
|
||||||
Homeservers that wish to conceal this information MAY return 200 responses
|
|
||||||
regardless of the existence of the reported user.
|
|
||||||
|
|
||||||
Furthermore, it might be possible for clients to deduce whether a reported
|
|
||||||
user exists by timing the response. This is because only a report for an
|
|
||||||
existing user will require the homeserver to do further processing. To
|
|
||||||
combat this, homeservers MAY add a random delay when generating a response.
|
|
||||||
operationId: reportUser
|
|
||||||
parameters:
|
|
||||||
- in: path
|
|
||||||
name: userId
|
|
||||||
description: The user being reported.
|
|
||||||
required: true
|
|
||||||
example: "@someguy:example.com"
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
format: mx-user-id
|
|
||||||
pattern: "^@"
|
|
||||||
requestBody:
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
type: object
|
|
||||||
example: {
|
|
||||||
"reason": "this makes me sad"
|
|
||||||
}
|
|
||||||
properties:
|
|
||||||
reason:
|
|
||||||
type: string
|
|
||||||
description: The reason the room is being reported. May be blank.
|
|
||||||
required:
|
|
||||||
- reason
|
|
||||||
required: true
|
|
||||||
security:
|
|
||||||
- accessTokenQuery: []
|
|
||||||
- accessTokenBearer: []
|
|
||||||
responses:
|
|
||||||
"200":
|
|
||||||
description: |
|
|
||||||
The user has been reported successfully or the server chose
|
|
||||||
to not disclose whether the users exists.
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
type: object
|
|
||||||
examples:
|
|
||||||
response:
|
|
||||||
value: {}
|
|
||||||
"404":
|
|
||||||
description: |-
|
|
||||||
The user was not found on the homeserver.
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: definitions/errors/error.yaml
|
|
||||||
examples:
|
|
||||||
response:
|
|
||||||
value: {
|
|
||||||
"errcode": "M_NOT_FOUND",
|
|
||||||
"error": "The user was not found."
|
|
||||||
}
|
|
||||||
"429":
|
|
||||||
description: This request was rate-limited.
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: definitions/errors/rate_limited.yaml
|
|
||||||
tags:
|
|
||||||
- Reporting content
|
|
||||||
servers:
|
servers:
|
||||||
- url: "{protocol}://{hostname}{basePath}"
|
- url: "{protocol}://{hostname}{basePath}"
|
||||||
variables:
|
variables:
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue