Skip to content

API_GetUserProfile has invalid documentation for UserWallActive #102

Open

Description

@sskorupski

When I do a GET request on https://retroachievements.org/API/API_GetUserProfile.php
Then I get a response like

{
    "User": "recidieu",
    "ULID": "01HQBSN8QERF35YJE25RD4N2JD",
    "UserPic": "/UserPic/recidieu.png",
    "MemberSince": "2024-02-23 20:14:12",
    "RichPresenceMsg": "Strategizing on Level 25 | ♥️ 1/5 💀 39 | 1860 Points",
    "LastGameID": 33403,
    "ContribCount": 0,
    "ContribYield": 0,
    "TotalPoints": 252,
    "TotalSoftcorePoints": 0,
    "TotalTruePoints": 639,
    "Permissions": 1,
    "Untracked": 0,
    "ID": 715357,
    "UserWallActive": 1,
    "Motto": ""
}

However, on the API page documentation
the example show that the field have a boolean type: "UserWallActive": true

Activity

  1. sskorupski commented on Feb 23, 2026

    @sskorupski
    ContributorAuthor

    I've opened the issue in the api-docs repository but if UserWallActive use 1 and 0, then I would suggest to close this issue and open an issue on the api repository to change the field serialization for returning true and false

  2. wescopeland commented on Feb 23, 2026

    @wescopeland
    Member

    The issue is valid - we'll hang on to true and false as the return values of the endpoint. If you feel inclined, please feel free to open a PR to correct the docs!

  3. sskorupski commented on Feb 23, 2026

    @sskorupski
    ContributorAuthor

    API_GetUserProfile.php seems to cast the field as int :
    'UserWallActive' => (int) $user->is_user_wall_active, and is_user_wall_active is defined as a boolean in User model

    @wescopeland, rollback the boolean to int for backward compatibilty (see PR #4392)

    So, I will keep this issue here and open a PR according to the actual bahavior.

  4. added a commit that references this issue on Feb 23, 2026
  5. sskorupski commented on Feb 23, 2026

    @sskorupski
    ContributorAuthor

    PR available #103

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions