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

Use consistent event examples throughout the Client-Server API #2051

Merged
merged 4 commits into from May 31, 2019

Conversation

Projects
None yet
2 participants
@turt2live
Copy link
Member

commented May 29, 2019

Fixes #1968
Fixes #1766

Reviewer: It's probably better to review this commit by commit.

Next step would be using consistent event IDs, room IDs, user IDs, etc to avoid having to override them all over the place.

@turt2live turt2live requested a review from matrix-org/spec-core-team May 29, 2019

Switch to using $ instead of # for sub-types
# is reserved by the swagger validator as a way to include partial content from a JSON object (eg: "#/path" would include {"test": true} from the object {"path":{"test":true}}). Instead of trying to convince the validator that it is wrong, we'll just use a different character.

Note that our rendering tools do not care about #-style references to objects. It's still somewhat worth changing the character though.

@turt2live turt2live force-pushed the travis/1.0/fix-examples branch from 589d50c to d6d74c4 May 29, 2019

@KitsuneRal
Copy link
Member

left a comment

LGTM. Also many thanks for the unification!

@turt2live turt2live merged commit ad07d8e into master May 31, 2019

8 checks passed

buildkite/matrix-doc Build #166 passed (1 minute, 2 seconds)
Details
ci/circleci: build-dev-scripts Your tests passed on CircleCI!
Details
ci/circleci: build-docs Your tests passed on CircleCI!
Details
ci/circleci: build-swagger Your tests passed on CircleCI!
Details
ci/circleci: check-docs Your tests passed on CircleCI!
Details
ci/circleci: validate-docs Your tests passed on CircleCI!
Details
docs Click details to preview the HTML documentation.
Details
swagger Click to preview the swagger build.
Details

@turt2live turt2live deleted the travis/1.0/fix-examples branch May 31, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.