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.

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

Add contains_url filter option and /messages filter #390

Merged
merged 6 commits into from Oct 3, 2016

Conversation

Projects
None yet
2 participants
@erikjohnston
Member

erikjohnston commented Sep 29, 2016

I'm not really sure the best way of spec'ing the filter param on /messages, suggestions welcome.

@richvdh

This comment has been minimized.

@erikjohnston

This comment has been minimized.

Member

erikjohnston commented Sep 29, 2016

yup

@@ -28,4 +28,8 @@ properties:
items:
type: string
type: array
contains_url:
type: boolean
description: If specified will filter events based on if they have a url key in their

This comment has been minimized.

@richvdh

richvdh Sep 30, 2016

Member

"If true, includes only events with a url key in their content. If false, excludes those events"

maybe?

This comment has been minimized.

@erikjohnston
type: string
name: filter
description: |-
A url encoded JSON RoomEventFilter to filter returned events with.

This comment has been minimized.

@richvdh

richvdh Sep 30, 2016

Member

well, of course it's url-encoded. it's a query-param. I don't think there is a need to specify this. Unless you mean it's double-encoded?

I would just say "A JSON-encoded RoomEventFilter to filter returned events with."

But the main thing it needs is an example.

This comment has been minimized.

@erikjohnston
@@ -35,6 +35,10 @@
- Add top-level ``account_data`` key to the responses to ``GET /sync`` and
``GET /initialSync``
(`#380 <https://github.com/matrix-org/matrix-doc/pull/380>`_).
- Add ``contains_url`` to ``RoomEventFilter``.

This comment has been minimized.

@richvdh

richvdh Sep 30, 2016

Member

"Add contains_url option" ?

This comment has been minimized.

@erikjohnston

@richvdh richvdh assigned erikjohnston and unassigned richvdh Sep 30, 2016

@erikjohnston erikjohnston assigned richvdh and unassigned erikjohnston Sep 30, 2016

@richvdh richvdh merged commit 2dde1a8 into master Oct 3, 2016

2 checks passed

Docs (Commit) Build #1816 succeeded in 27 sec
Details
Docs (Merged PR) Build finished.
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment