Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-01-02 14:08:38 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #1278 from matrix-org/t3chguy/search_docs

Browse source 
Fix two issues with /search docs
This commit is contained in:
Richard van der Hoff 2018-06-05 11:13:50 +01:00 committed by GitHub
parent ee98082a60 968ee0f613
commit 92cf91dc69
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 21 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -53,16 +53,16 @@ paths:
"keys": [
"content.body"
],
"search_term": "martians and men"
}
},
"order_by": "recent",
"groupings": {
"group_by": [
{
"key": "room_id"
"search_term": "martians and men",
"order_by": "recent",
"groupings": {
"group_by": [
{
"key": "room_id"
}
]
}
]
}
}
}
properties:
@ -181,6 +181,12 @@ paths:
count:
type: number
description: An approximate count of the total number of results found.
highlights:
type: array
title: Highlights
description: List of words which should be highlighted, useful for stemming which may change the query terms.
items:
type: string
results:
type: array
title: Results
@ -318,6 +324,10 @@ paths:
}
}
},
"highlights": [
"martians",
"men"
],
"next_batch": "5FdgFsd234dfgsdfFD",
"count": 1224,
"results": [

2
changelogs/client_server.rst
View file

@ -54,6 +54,8 @@ Unreleased changes
(`#1264 <https://github.com/matrix-org/matrix-doc/pull/1264>`_).
- Document ``/logout/all`` endpoint
(`#1263 <https://github.com/matrix-org/matrix-doc/pull/1263>`_).
- Document `highlights` field in /search response
(`#1274 <https://github.com/matrix-org/matrix-doc/pull/1274>`_).
r0.3.0
======