diff --git a/api/client-server/search.yaml b/api/client-server/search.yaml index 946d1ba7..c4f38fa1 100644 --- a/api/client-server/search.yaml +++ b/api/client-server/search.yaml @@ -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 diff --git a/changelogs/client_server.rst b/changelogs/client_server.rst index 1e930e77..233f7480 100644 --- a/changelogs/client_server.rst +++ b/changelogs/client_server.rst @@ -14,7 +14,9 @@ Unreleased changes endpoints as deprecated (`#1097 `_). - Fix response format of ``/keys/changes`` endpoint - (`#1106 `_) + (`#1106 `_). + - Clarify default values for some fields on the /search API + (`#1109 `_). - Changes to the API which will be backwards-compatible for clients: