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

Merge GET/PUT /state/:event_type endpoints #2088

Merged
merged 1 commit into from Jun 11, 2019

Conversation

Projects
None yet
2 participants
@turt2live
Copy link
Member

commented Jun 6, 2019

Clarifying that the state key is optional, and how that works.

Fixes #1182

Merge GET/PUT /state/:event_type endpoints
Clarifying that the state key is optional, and how that works.

Fixes #1182

@turt2live turt2live added the Matrix 1.0 label Jun 6, 2019

@turt2live turt2live requested a review from matrix-org/spec-core-team Jun 6, 2019

@@ -99,68 +104,3 @@ paths:
}
tags:
- Room participation
"/rooms/{roomId}/state/{eventType}":

This comment has been minimized.

Copy link
@erikjohnston

erikjohnston Jun 10, 2019

Member

Do we not need to update the path somewhere so that swagger knows the {state_key} is optional?

This comment has been minimized.

Copy link
@turt2live

turt2live Jun 10, 2019

Author Member

Swagger says all path parameters are required. We work around this by putting text in saying it may be an empty string, but still required.

This comment has been minimized.

Copy link
@erikjohnston

erikjohnston Jun 10, 2019

Member

Isn't that going to be annoying for the client folk who auto-generate API interfaces from swagger? Or have people stopped doing that now?

This comment has been minimized.

Copy link
@turt2live

turt2live Jun 10, 2019

Author Member

It might cause problems, but I'm of the opinion that reducing confusion in the spec is more important than people's auto-generated output being wrong (and easily correctable).

tbh, this is the least of our concerns with swagger right now.

@turt2live turt2live requested a review from erikjohnston Jun 10, 2019

@turt2live turt2live merged commit 39b79fe into master Jun 11, 2019

8 checks passed

buildkite/matrix-doc Build #230 passed (1 minute, 3 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/duplicate-state-endpoint branch Jun 11, 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.