Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-01-04 15:03:43 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #236 from matrix-org/rav/search_spec_fixes

Browse source 
Tweaks/clarifications to search spec
This commit is contained in:
Richard van der Hoff 2015-12-17 14:12:49 +00:00
parent 34bab312d3 e4dd346a81
commit 20c7af3186
2 changed files with 22 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -20,12 +20,19 @@ securityDefinitions:
paths:
"/search":
post:
summary: Search server side for things.
summary: Perform a server-side search.
description: |-
Performs a full text search across different categories.
security:
- accessToken: []
parameters:
- in: query
name: next_batch
type: string
description: |-
The point to return events from. If given, this should be a
`next_batch` result from a previous call to this endpoint.
x-example: "YWxsCgpOb25lLDM1ODcwOA"
- in: body
name: body
schema:
@ -260,8 +267,11 @@ paths:
type: string
title: Next Batch in Group
description: |-
Token that can be used to get the next
batch of results in the group, if exists.
Token that can be used to get the next batch
of results in the group, by passing as the
`next_batch` parameter to the next call. If
this field is absent, there are no more
results in this group.
order:
type: integer
title: Group Order
@ -280,7 +290,9 @@ paths:
title: Next Batch
description: |-
Token that can be used to get the next batch of
results, if exists.
results, by passing as the `next_batch` parameter to
the next call. If this field is absent, there are no
more results.
examples:
application/json: |-
{

10
specification/modules/search.rst
View file

@ -10,6 +10,8 @@ events in rooms that happened after you left.
Client behaviour
----------------
There is a single HTTP API for performing server-side search, documented below.
{{search_http_api}}
Search Categories
@ -36,9 +38,9 @@ The search will *not* include rooms that are end to end encrypted.
The results include a ``rank`` key that can be used to sort the results by
relevancy. The higher the ``rank`` the more relevant the result is.
The value of ``count`` may not match the number of results. For example due to
the search query matching 1000s of results and the server truncating the
response.
The value of ``count`` gives an approximation of the total number of
results. Homeservers may give an estimate rather than an exact value for this
field.
Ordering
--------
@ -84,7 +86,7 @@ The currently supported locations for the ``next_batch`` token are:
- ``search_categories.<category>.groups.<group_key>.<group_id>.next_batch``
A server need not support pagination, even if there are more matching results.
In which case they must not return a ``next_batch`` token in the response.
In that case, they must not return a ``next_batch`` token in the response.
Security considerations