-
Notifications
You must be signed in to change notification settings - Fork 384
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
Spec /account/whoami #1063
Spec /account/whoami #1063
Conversation
Signed-off-by: Travis Ralston <[email protected]>
Can one of the admins verify this patch? |
Signed-off-by: Travis Ralston <[email protected]>
Signed-off-by: Travis Ralston <[email protected]>
matrixbot: test this please |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks good except for a couple of nits!
application/json: { | ||
"user_id": "@joe:example.org" | ||
} | ||
schema: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this needs a required: ['user_id']
(iirc)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not seeing that on other response schemas, is that needed for both responses and requests?
I've addressed the other concerns.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've added the required
node. All of the references I used didn't have it, but some older documentation does (media repo, for instance).
api/client-server/whoami.yaml
Outdated
# limitations under the License. | ||
swagger: '2.0' | ||
info: | ||
title: "Matrix Client-Server Client Config API" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this looks like an inappropriate c&p.
api/client-server/whoami.yaml
Outdated
summary: Gets information about the owner of an access token. | ||
description: |- | ||
Gets information about the owner of a given access token. Currently this | ||
only supports returning the user id that owns the token. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure this second sentence is adding any value tbh.
Signed-off-by: Travis Ralston <[email protected]>
Signed-off-by: Travis Ralston <[email protected]>
THanks! |
Clients may wish to be able to identify which user they are supposed to be representing from only an access token. This new endpoint gives limited information to the client about the authenticated user.