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

Document `validated_at`, `added_at`, and POST /3pid/delete #1567

Merged
merged 7 commits into from Aug 30, 2018

Conversation

2 participants
@turt2live
Member

turt2live commented Aug 27, 2018

Rendered: see 'docs' status check


Document validated_at and added_at on GET /3pid
Fixes #661

Document POST /account/3pid/delete
Fixes #985
Includes documentation for matrix-org/synapse#3667
Raises #1566

@turt2live turt2live requested a review from 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

summary: Deletes a third party identifier from the user's account
description: |-
Removes a third party identifier from the user's account. The homeserver
should attempt to unbind the identifier from the identity service, if the

This comment has been minimized.

@uhoreg

uhoreg Aug 30, 2018

Member

I think this needs to say how to unbind, which unfortunately requires #1194 which is not in the spec yet, so I don't know if we can actually have this sentence in here. :-/

The result of the homeserver's attempt to unbind the identifier from
the identity service. ``success`` indicates that the homeserver was
able to unbind the identifier while ``no-support`` means the homeserver
was not able to unbind, likely due to the identity service not supporting

This comment has been minimized.

@uhoreg

uhoreg Aug 30, 2018

Member

I think that "likely due to" is unclear. Maybe a clearer statement would be something like "and that the identity service returned an HTTP error code (400, 404, or 501) indicating that it does not support the operation. If the identity service returns an error indicating that unbinding failed for some other reason, then this endpoint will return an error.".

turt2live added some commits Aug 30, 2018

Remove mentions of identity services from /3pid/delete
This will be covered by #1194

For now, we can accept that homeservers may try to unbind, however clients should not rely on it.

@turt2live turt2live requested a review from uhoreg Aug 30, 2018

@uhoreg

uhoreg approved these changes Aug 30, 2018

lgtm other than a wording change

post:
summary: Deletes a third party identifier from the user's account
description: |-
Removes a third party identifier from the user's account. This may not

This comment has been minimized.

@uhoreg

uhoreg Aug 30, 2018

Member

"may not" could be read as forbidding unbinding from the identity service, so I think it would be better to say "might not". (interestingly, RFC2119 says nothing about the phrase "may not", even though it defines "must not" and "should not")

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

@turt2live turt2live merged commit ce14779 into matrix-org:master Aug 30, 2018

7 checks passed

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

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

@turt2live turt2live deleted the turt2live:travis/c2s/3pid-binding branch Aug 30, 2018

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