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

Document the defaults for the /search API

Browse source
This commit is contained in:
Michael Telatynski 2018-01-30 14:29:59 +00:00
parent f0f91bd9bc
commit dc27323d8b
No known key found for this signature in database
GPG key ID: 3F879DA5AD802A5E
1 changed files with 6 additions and 3 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