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.

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

erikjohnston
Copy link
Member

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

@richvdh
Copy link
Member

richvdh commented Sep 29, 2016

@erikjohnston
Copy link
Member Author

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

maybe?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

type: string
name: filter
description: |-
A url encoded JSON RoomEventFilter to filter returned events with.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@@ -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``.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Add contains_url option" ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@richvdh richvdh assigned erikjohnston and unassigned richvdh Sep 30, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants