Skip to content

Updated users.md to reflect current state of the user structure #132

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.

Sign up for GitHub

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

Open
bigfoott wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Updated users.md to reflect current state of the user structure #132

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c674f79
updated users.md to reflect current state of the user object
bigfoott Aug 20, 2021
6abcf8b
added missing comma to user json structure
bigfoott Oct 3, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions version1/users.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Represented as JSON, a single user looks like this:
"international": "chewdiggy",
"japanese": null
},
"pronouns": null,
"weblink": "https://www.speedrun.com/user/chewdiggy",
"name-style": {
"style": "solid",
Expand Down Expand Up @@ -64,6 +65,14 @@ Represented as JSON, a single user looks like this:
"speedrunslive": {
"uri": "http://www.speedrunslive.com/profiles/#!/username"
},
"assets": {
"icon": {
"uri": null
},
"image": {
"uri": "https://www.speedrun.com/userasset/48gr0rxp/image?v=cbb14df"
}
},
"links": [{
"rel": "self",
"uri": "https://www.speedrun.com/api/v1/users/kjpdr4jq"
Expand All @@ -84,6 +93,8 @@ There are quite a few things that need a couple words of explanation.

* Most users don't have a ``japanese`` name.

* ``pronouns`` can either be null or a single string that contains all of a user's set pronouns.

* The ``name-style`` determines how the username is shown on the website and can be one of two things:

* When ``style`` is ``solid``, there is one ``color``.
Expand All @@ -106,6 +117,8 @@ There are quite a few things that need a couple words of explanation.

* Any of the ``twitch``, ``hitbox``, ``youtube``, ``twitter`` and ``speedrunslive`` links can be
``null``.

* ``assets`` are links to images set by the user on speedrun.com. The links for both ``icon`` and ``image`` can be null.

### GET /users

Expand Down