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

Update filtering API documentation #1570

Merged
merged 6 commits into from
Aug 28, 2018

Conversation

turt2live
Copy link
Member

Rendered: see 'docs' status check

This PR may be best to review commit-by-commit.


Fix naming of the Filter schemas
EventFilter !== Filter
Fixes #1509

Update room_event_filter.yaml to use the OpenAPI allOf definition

Mark the filter_id in the response of POST /filter as required

Clean up examples in filter.yaml

Define the default for the contains_url filter param
Fixes #1553

@turt2live turt2live requested review from ara4n and a team August 27, 2018 03:23
@turt2live
Copy link
Member Author

@ara4n I'm particularly interested if this helps/harms/has no effect on #1508. Without major changes to the build/rendering process, I don't think it can be made much clearer.

turt2live added a commit to turt2live/matrix-doc that referenced this pull request Aug 27, 2018
@ara4n
Copy link
Member

ara4n commented Aug 28, 2018

i think this almost fixes #1508, but it still needs CSS to actually make the tables & headings legible. That's an entirely separate problem though (although one i'd like to try to fix this week somehow!)

Copy link
Member

@ara4n ara4n left a comment

Choose a reason for hiding this comment

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

lgtm

@turt2live
Copy link
Member Author

I've updated the title of #1508 to be more generic in respect to fixing it spec-wide. I'd say it's unlikely to get done before Friday, however there is some light at the end of the r0 tunnel. I'll put on the r0 list under the cosmetic fixes (as that's what it is), although all the cosmetic stuff is under the heading "if we have time...".

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