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

Jump to bottom

Document the defaults for the /search API #1109

Merged
merged 3 commits into from Feb 6, 2018
Merged

Document the defaults for the /search API #1109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dc27323
Document the defaults for the /search API
t3chguy Jan 30, 2018
06911d4
Merge branch 'master' of https://github.com/matrix-org/matrix-doc int…
t3chguy Jan 30, 2018
436e2cd
Add changelog entry for /search API default value clarifications
t3chguy Jan 30, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 6 additions & 3 deletions api/client-server/search.yaml
View file
Open in desktop
Expand Up @@ -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
Expand All @@ -112,20 +114,21 @@ 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"
description: |-
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
Expand Down
4 changes: 3 additions & 1 deletion changelogs/client_server.rst
View file
Open in desktop
Expand Up @@ -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:

Expand Down