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

Spec /account/whoami #1063

Merged
merged 5 commits into from
Nov 14, 2017
Merged

Spec /account/whoami #1063

merged 5 commits into from
Nov 14, 2017

Conversation

turt2live
Copy link
Member

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.

Signed-off-by: Travis Ralston <[email protected]>
@matrixbot
Copy link
Member

Can one of the admins verify this patch?

@richvdh
Copy link
Member

richvdh commented Nov 13, 2017

matrixbot: test this please

Copy link
Member

@richvdh richvdh left a 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:
Copy link
Member

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)

Copy link
Member Author

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.

Copy link
Member Author

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).

# limitations under the License.
swagger: '2.0'
info:
title: "Matrix Client-Server Client Config API"
Copy link
Member

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.

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.
Copy link
Member

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]>
@richvdh
Copy link
Member

richvdh commented Nov 14, 2017

THanks!

@richvdh richvdh merged commit 85340a9 into matrix-org:master Nov 14, 2017
@turt2live turt2live deleted the travis/whoami branch March 6, 2018 22:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants