Document validated_at, added_at, and POST /3pid/delete
#1567
Conversation
Fixes matrix-org#985 Includes documentation for matrix-org/synapse#3667 Raises https://github.com/matrix-org/matrix-doc/issues/1566
| 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 |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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.".
This will be covered by matrix-org#1194 For now, we can accept that homeservers may try to unbind, however clients should not rely on it.
| 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 |
There was a problem hiding this comment.
"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")
Rendered: see 'docs' status check
Document
validated_atandadded_aton GET /3pidFixes #661
Document POST /account/3pid/delete
Fixes #985
Includes documentation for matrix-org/synapse#3667
Raises matrix-org/matrix-spec#354