Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mark from parameter as optional for /messages #1002

Merged
merged 5 commits into from
Mar 29, 2022
Merged

Mark from parameter as optional for /messages #1002

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6fb2669
Marking `from` parameter as optional
germain-gg Jan 12, 2022
523ad2c
Add x-changedInMatrixVersion for from param
germain-gg Jan 17, 2022
870010b
Add a changelog entry for MSC3567
jplatte Mar 25, 2022
117e364
Update /messages from parameter x-changedInMatrixVersion value
jplatte Mar 25, 2022
a2f18d9
Add note to x-changedInMatrixVersion
jplatte Mar 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelogs/client_server/newsfragments/1002.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Make `from` optional on `GET /_matrix/client/v3/messages` to allow requesting events from the start or end of the room history, as per [MSC3567](https://github.com/matrix-org/matrix-doc/pull/3567).
44 changes: 27 additions & 17 deletions data/api/client-server/message_pagination.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
# 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'
swagger: "2.0"
info:
title: "Matrix Client-Server Rooms API"
version: "1.0.0"
Expand Down Expand Up @@ -49,6 +49,10 @@ paths:
- in: query
type: string
name: from
x-changedInMatrixVersion:
1.3: |
Previously, this field was required and paginating from the first or
last visible event in the room history wasn't supported.
description: |-
The token to start returning events from. This token can be obtained
from a `prev_batch` or `next_batch` token returned by the `/sync` endpoint,
Expand All @@ -57,7 +61,11 @@ paths:
This endpoint can also accept a value returned as a `start` token
by a previous request to this endpoint, though servers are not
required to support this. Clients should not rely on the behaviour.
required: true

If it is not provided, the homeserver shall return a list of messages
from the first or last (per the value of the `dir` parameter) visible
event in the room history for the requesting user.
required: false
x-example: "s345_678_333"
- in: query
type: string
Expand Down Expand Up @@ -141,23 +149,25 @@ paths:
$ref: "definitions/client_event.yaml"
required: [start, chunk]
examples:
application/json: {
application/json:
{
"start": "t47429-4392820_219380_26003_2265",
"end": "t47409-4357353_219380_26003_2265",
"chunk": [
{
"room_id": "!636q39766251:example.com",
"$ref": "../../event-schemas/examples/m.room.message$m.text.yaml"
},
{
"room_id": "!636q39766251:example.com",
"$ref": "../../event-schemas/examples/m.room.name.yaml"
},
{
"room_id": "!636q39766251:example.com",
"$ref": "../../event-schemas/examples/m.room.message$m.video.yaml"
}
]
"chunk":
[
{
"room_id": "!636q39766251:example.com",
"$ref": "../../event-schemas/examples/m.room.message$m.text.yaml",
},
{
"room_id": "!636q39766251:example.com",
"$ref": "../../event-schemas/examples/m.room.name.yaml",
},
{
"room_id": "!636q39766251:example.com",
"$ref": "../../event-schemas/examples/m.room.message$m.video.yaml",
},
],
}
403:
description: >
Expand Down