mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-03-26 13:04:10 +01:00
112 lines
3.9 KiB
YAML
112 lines
3.9 KiB
YAML
# Copyright 2018 Travis Ralston
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
swagger: '2.0'
|
|
info:
|
|
title: "Matrix Client-Server Report Content API"
|
|
version: "1.0.0"
|
|
host: localhost:8008
|
|
schemes:
|
|
- https
|
|
- http
|
|
basePath: /_matrix/client/v3
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
securityDefinitions:
|
|
$ref: definitions/security.yaml
|
|
paths:
|
|
"/rooms/{roomId}/report/{eventId}":
|
|
post:
|
|
summary: Report an event in a joined room as inappropriate.
|
|
description: |-
|
|
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
|
|
it.
|
|
|
|
It can be possible for clients to deduce whether an event exists by
|
|
timing the response, as only a report for an event that does exist
|
|
will require the homeserver to check whether a user is joined to
|
|
the room. To combat this, homeserver implementations are encouraged
|
|
to add a random delay when generating the response.
|
|
|
|
It might be possible for clients to deduce whether an event exists by
|
|
timing the response, as only a report for an event that does exist
|
|
will require the homeserver to check whether a user is joined to
|
|
the room. To combat this, homeserver implementations should add
|
|
a random delay when generating a response.
|
|
operationId: reportContent
|
|
parameters:
|
|
- in: path
|
|
type: string
|
|
name: roomId
|
|
description: The room in which the event being reported is located.
|
|
required: true
|
|
x-example: "!637q39766251:example.com"
|
|
- in: path
|
|
type: string
|
|
name: eventId
|
|
description: The event to report.
|
|
required: true
|
|
x-example: "$something:example.org"
|
|
- in: body
|
|
name: body
|
|
required: true
|
|
schema:
|
|
type: object
|
|
example: {
|
|
"score": -100,
|
|
"reason": "this makes me sad"
|
|
}
|
|
properties:
|
|
score:
|
|
type: integer
|
|
description: |-
|
|
The score to rate this content as where -100 is most offensive
|
|
and 0 is inoffensive.
|
|
reason:
|
|
type: string
|
|
description: The reason the content is being reported. May be blank.
|
|
security:
|
|
- accessToken: []
|
|
x-changedInMatrixVersion:
|
|
1.7: |
|
|
This endpoint now requires the user to be joined to the room.
|
|
responses:
|
|
200:
|
|
description: The event has been reported successfully.
|
|
schema:
|
|
type: object
|
|
examples:
|
|
application/json: {}
|
|
404:
|
|
description: |-
|
|
The event was not found or you are not joined to the room where the
|
|
event resides.
|
|
|
|
Homeserver implementations can additionally return this error if the
|
|
reported event has been redacted.
|
|
|
|
Homeserver implementations may additionally return this error if the
|
|
reported event has been redacted.
|
|
examples:
|
|
application/json: {
|
|
"errcode": "M_NOT_FOUND",
|
|
"error": "The event was not found or you are not joined to the room."
|
|
}
|
|
schema:
|
|
$ref: "../client-server/definitions/errors/error.yaml"
|
|
tags:
|
|
- Reporting content
|