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

2 participants
@turt2live
Member

turt2live commented Aug 27, 2018

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 matrix-org/spec-core-team Aug 27, 2018

@turt2live turt2live added this to In review (just the PRs) in August 2018 r0 via automation Aug 27, 2018

@turt2live

This comment has been minimized.

Member

turt2live commented Aug 27, 2018

@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

This comment has been minimized.

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!)

@ara4n

ara4n approved these changes Aug 28, 2018

lgtm

August 2018 r0 automation moved this from In review (just the PRs) to Reviewer approved Aug 28, 2018

@turt2live

This comment has been minimized.

Member

turt2live commented Aug 28, 2018

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...".

@turt2live turt2live merged commit 9527ce3 into matrix-org:master Aug 28, 2018

4 checks passed

ci/circleci: build-docs Your tests passed on CircleCI!
Details
ci/circleci: build-swagger Your tests passed on CircleCI!
Details
docs Click details to preview the HTML documentation.
Details
swagger Click to preview the swagger build.
Details

August 2018 r0 automation moved this from Reviewer approved to Done (this list will be incomplete) Aug 28, 2018

@turt2live turt2live deleted the turt2live:travis/c2s/sync-filtering branch Aug 28, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment