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 msisdn-related endpoints in IS #1507

Merged
merged 4 commits into from Aug 17, 2018

Conversation

3 participants
@uhoreg
Member

uhoreg commented Aug 14, 2018

Most of this is a copy-and-paste from the email endpoints, but hopefully I've caught all the necessary edits.

The main question I have is that sydent doesn't seem to return any error codes for the /requestToken endpoint, and the error codes from the email/requestToken endpoint are email-specific, so I'm not sure what to document as error codes.

@uhoreg

This comment has been minimized.

Member

uhoreg commented Aug 14, 2018

Another thing to consider is whether we want to spec an error code for an IS to indicate that it doesn't support msisdn verification.

@turt2live turt2live requested a review from dbkr Aug 14, 2018

@turt2live

This comment has been minimized.

Member

turt2live commented Aug 14, 2018

(review requesting for magic tracking)

@turt2live turt2live added this to Needs review in August 2018 r0 Aug 14, 2018

August 2018 r0 automation moved this from In review to Reviewer approved Aug 15, 2018

@dbkr

dbkr approved these changes Aug 15, 2018

description: An email was sent to the given address.
"/account/3pid/msisdn/requestToken":
post:
summary: Requests a validation token be sent to the given email address for the purpose of adding a phone number address to an account.

This comment has been minimized.

@dbkr

dbkr Aug 15, 2018

Member

s/address//?

description: |
An error ocurred. Some possible errors are:
- FIXME: sydent doesn\'t seem to send any error codes at all

This comment has been minimized.

@dbkr

dbkr Aug 15, 2018

Member

Mm, this is probably a screw-up on my part. I don't really see any reason the error codes should be email specific: M_INVALID_ADDRESS and M_SEND_ERROR would do just as well and be reusable for whatever medium. We could spec generic ones for the msisdn endpoints and leave it as a wart that the email ones are email-specific and fix it in a separate change?

@uhoreg uhoreg merged commit f5dc0ea into matrix-org:master Aug 17, 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 17, 2018

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