move /rooms/{roomId}/event/{eventId} and update depr notice
This commit is contained in:
parent
ebea850838
commit
c5816a80af
3 changed files with 44 additions and 44 deletions
|
@ -407,7 +407,7 @@ paths:
|
||||||
retrieve this event e.g. by being a member in the room for this event.
|
retrieve this event e.g. by being a member in the room for this event.
|
||||||
|
|
||||||
This endpoint was deprecated in r0 of this specification. Clients
|
This endpoint was deprecated in r0 of this specification. Clients
|
||||||
should instead call the |/rooms/{roomId}/context/{eventId}|_ API.
|
should instead call the |/rooms/{roomId}/event/{eventId}|_ API.
|
||||||
operationId: getOneEvent
|
operationId: getOneEvent
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
|
|
|
@ -27,6 +27,49 @@ produces:
|
||||||
securityDefinitions:
|
securityDefinitions:
|
||||||
$ref: definitions/security.yaml
|
$ref: definitions/security.yaml
|
||||||
paths:
|
paths:
|
||||||
|
"/rooms/{roomId}/event/{eventId}":
|
||||||
|
get:
|
||||||
|
summary: Get a single event by event ID.
|
||||||
|
description: |-
|
||||||
|
Get a single event based on ``roomId/eventId``. You must have permission to
|
||||||
|
retrieve this event e.g. by being a member in the room for this event.
|
||||||
|
operationId: getOneRoomEvent
|
||||||
|
security:
|
||||||
|
- accessToken: []
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
type: string
|
||||||
|
name: roomId
|
||||||
|
description: The ID of the room the event is in.
|
||||||
|
required: true
|
||||||
|
x-example: "!asfDuShaf7Gafaw:matrix.org"
|
||||||
|
- in: path
|
||||||
|
type: string
|
||||||
|
name: eventId
|
||||||
|
description: The event ID to get.
|
||||||
|
required: true
|
||||||
|
x-example: "$asfDuShaf7Gafaw:matrix.org"
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
description: The full event.
|
||||||
|
examples:
|
||||||
|
application/json: {
|
||||||
|
"content": {
|
||||||
|
"body": "Hello world!",
|
||||||
|
"msgtype": "m.text"
|
||||||
|
},
|
||||||
|
"room_id": "!wfgy43Sg4a:matrix.org",
|
||||||
|
"sender": "@bob:matrix.org",
|
||||||
|
"event_id": "$asfDuShaf7Gafaw:matrix.org",
|
||||||
|
"type": "m.room.message"
|
||||||
|
}
|
||||||
|
schema:
|
||||||
|
allOf:
|
||||||
|
- "$ref": "definitions/event-schemas/schema/core-event-schema/event.yaml"
|
||||||
|
404:
|
||||||
|
description: The event was not found or you do not have permission to read this event.
|
||||||
|
tags:
|
||||||
|
- Room participation
|
||||||
"/rooms/{roomId}/state/{eventType}/{stateKey}":
|
"/rooms/{roomId}/state/{eventType}/{stateKey}":
|
||||||
get:
|
get:
|
||||||
summary: Get the state identified by the type and key.
|
summary: Get the state identified by the type and key.
|
||||||
|
|
|
@ -366,46 +366,3 @@ paths:
|
||||||
}
|
}
|
||||||
tags:
|
tags:
|
||||||
- Room participation
|
- Room participation
|
||||||
"/rooms/{roomId}/event/{eventId}":
|
|
||||||
get:
|
|
||||||
summary: Get a single event by event ID.
|
|
||||||
description: |-
|
|
||||||
Get a single event based on ``roomId/eventId``. You must have permission to
|
|
||||||
retrieve this event e.g. by being a member in the room for this event.
|
|
||||||
operationId: getOneRoomEvent
|
|
||||||
security:
|
|
||||||
- accessToken: []
|
|
||||||
parameters:
|
|
||||||
- in: path
|
|
||||||
type: string
|
|
||||||
name: roomId
|
|
||||||
description: The ID of the room the event is in.
|
|
||||||
required: true
|
|
||||||
x-example: "!asfDuShaf7Gafaw:matrix.org"
|
|
||||||
- in: path
|
|
||||||
type: string
|
|
||||||
name: eventId
|
|
||||||
description: The event ID to get.
|
|
||||||
required: true
|
|
||||||
x-example: "$asfDuShaf7Gafaw:matrix.org"
|
|
||||||
responses:
|
|
||||||
200:
|
|
||||||
description: The full event.
|
|
||||||
examples:
|
|
||||||
application/json: {
|
|
||||||
"content": {
|
|
||||||
"body": "Hello world!",
|
|
||||||
"msgtype": "m.text"
|
|
||||||
},
|
|
||||||
"room_id": "!wfgy43Sg4a:matrix.org",
|
|
||||||
"sender": "@bob:matrix.org",
|
|
||||||
"event_id": "$asfDuShaf7Gafaw:matrix.org",
|
|
||||||
"type": "m.room.message"
|
|
||||||
}
|
|
||||||
schema:
|
|
||||||
allOf:
|
|
||||||
- "$ref": "definitions/event-schemas/schema/core-event-schema/event.yaml"
|
|
||||||
404:
|
|
||||||
description: The event was not found or you do not have permission to read this event.
|
|
||||||
tags:
|
|
||||||
- Room participation
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue