1159354 - Implement GET /api/v1/users/me

Status: RESOLVED FIXED

(developer.mozilla.org Graveyard :: BrowserCompat, defect)

Description

[John Whitlock [:jwhitlock]]

What problem would this feature solve?
======================================
When using an authenticated session or an auth token, determine the user account

Who has this problem?
=====================
API client writers

How do you know that the users identified above have this problem?
==================================================================
Not yet a problem.  The API is in progress, and this feature is only needed by API client writers.

How are the users identified above solving this problem now?
============================================================
In the browser, the HTML includes the login state, and the profile pages give detailed information. For existing API tools, logging in is usually the first step, so the user is known.

Do you have any suggestions for solving the problem? Please explain in detail.
==============================================================================
The proposed implementation is documented in the API design docs: http://web-platform-compat.readthedocs.org/en/latest/draft/change-control.html#users

Is there anything else we should know?
======================================
This may be related to slug-based lookups, bug 1078699

Comment 1

[Renoir Boulanger [:renoirb]]

Is this bug related on how to lookup up with Kuma to make writes?

Comment 2

[John Whitlock [:jwhitlock]]

This endpoint answers the questions "Are you authenticated against the BrowserCompat API? Who are you? What permissions do you have?".  You present your token, or your cookie, and get an answer.

There are no open bugs yet for similar questions of the Kuma API.

Comment 3

[John Whitlock [:jwhitlock]]

Bumping severity to normal, because needed for clients of token-based authentication (bug 1230604)

Comment 4

[MDN Team (:mdn-dev)]

Commits pushed to master at https://github.com/mdn/browsercompat

https://github.com/mdn/browsercompat/commit/83ed530560c94dc1025863091964a7f2319ea183
bug 1159354 - Add /api/v#/users/me endpoint

If a client is authenticated, then this endpoint returns a 302 redirect
to the user's resource. If not authenticated, the response is a 401
Unauthorized (if authentication can be recommended in the
WWW-Authenticate header) or 403 Forbidden (if it can't).

https://github.com/mdn/browsercompat/commit/50f283abcc62cc8d90267f0a6ac4554e0884408a
bug 1159354 - Add tests, docs for /users/me

Includes some additional handling for the new Location and
WWW-Authenticate headers not seen before in documentation.

https://github.com/mdn/browsercompat/commit/d7914155285383d9c67ca02a684392cf2b07f9db
Merge pull request #102 from mdn/users_me_1159354

bug 1159354 - Add /api/v#/users/me endpoint