wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request #1109 from t3chguy/t3chguy/search_defaults

Browse source 
Document the defaults for the /search API
This commit is contained in:
Richard van der Hoff 2018-02-06 15:42:47 +01:00 • committed by GitHub
commit 96fa29ad03
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

9
api/client-server/search.yaml
View file

@ -99,7 +99,9 @@ paths:
title: "Ordering"
type: string
enum: ["recent", "rank"]
description: "The order in which to search for results."
description: |-
The order in which to search for results.
By default, this is ``"rank"``.
event_context:
title: "Event Context"
type: object
@ -112,13 +114,13 @@ paths:
title: "Before limit"
description: |-
How many events before the result are
returned.
returned. By default, this is ``5``.
after_limit:
type: integer
title: "After limit"
description: |-
How many events after the result are
returned.
returned. By default, this is ``5``.
include_profile:
type: boolean
title: "Return profile information"
@ -126,6 +128,7 @@ paths:
Requests that the server returns the
historic profile information for the users
that sent the events that were returned.
By default, this is ``false``.
include_state:
type: boolean
title: Include current state

4
changelogs/client_server.rst
View file

@ -14,7 +14,9 @@ Unreleased changes
endpoints as deprecated
(`#1097 <https://github.com/matrix-org/matrix-doc/pull/1097>`_).
- Fix response format of ``/keys/changes`` endpoint
(`#1106 <https://github.com/matrix-org/matrix-doc/pull/1106>`_)
(`#1106 <https://github.com/matrix-org/matrix-doc/pull/1106>`_).
- Clarify default values for some fields on the /search API
(`#1109 <https://github.com/matrix-org/matrix-doc/pull/1109>`_).
- Changes to the API which will be backwards-compatible for clients: