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

Clarify some of the properties on the search result #1400

Merged
merged 2 commits into from Jul 12, 2018
Merged

Clarify some of the properties on the search result #1400

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fbee83d
Clarify some of the properties on the search result
turt2live Jul 10, 2018
b6f9e13
Add newsfragment
turt2live Jul 10, 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
14 changes: 13 additions & 1 deletion api/client-server/search.yaml
View file
Open in desktop
Expand Up @@ -227,6 +227,9 @@ paths:
description: |-
The historic profile information of the
users that sent the events returned.

The ``string`` key is the user ID for which
the profile belongs to.
additionalProperties:
type: object
title: User Profile
Expand Down Expand Up @@ -260,15 +263,24 @@ paths:
The current state for every room in the results.
This is included if the request had the
``include_state`` key set with a value of ``true``.

The ``string`` key is the room ID for which the ``State
Event`` array belongs to.
additionalProperties:
type: array
title: Room State
items:
type: object
"$ref": "definitions/event-schemas/schema/core-event-schema/state_event.yaml"
groups:
type: object
title: Groups
description: Any groups that were requested.
description: |-
Any groups that were requested.

The outer ``string`` key is the group key requested (eg: ``room_id``
or ``sender``). The inner ``string`` key is the grouped value (eg:
a room's ID or a user's ID).
additionalProperties:
type: object
title: Group Key
Expand Down
1 change: 1 addition & 0 deletions changelogs/client_server/newsfragments/1400.clarification
View file
Open in desktop
@@ -0,0 +1 @@
Clarify some of the properties on the search result