Inconsistency Between Documented and Actual API Responses: user_id Missing in /users Endpoint Responses #5178

[ln-ws]

Describe the Bug

The API documentation indicates that responses from the /users endpoint should include both id and user_id properties. However, in practice, the actual API responses only contain the id property, and the user_id property is missing.

Steps to Reproduce

1. Send a LIST request to the /users endpoint on your BookStack server.
2. Review the response returned by the server.
3. Notice that the user_id property is missing from the response, despite being documented.

Expected Behaviour

The response from the /users endpoint should include both id and user_id properties, where the user_id property matches the value of the id property for each user object within the data array.

Screenshots or Additional Context

No response

Browser Details

No response

Exact BookStack Version

v24.05.3

[ssddanbrown]

I'm deleting all above comments as I don't see any as relevant to the discussion, or they contain links to downloads on other sites that I'm not comfortable with having here, and/or they contain claims I'm not going to validate.
Any further links to external downloads (including archive links) will result in a block for BookStackApp projects.

[ssddanbrown]

Thanks for raising @ln-ws.
I can confirm the example response does not match the actual response.
I'll just look to remove the user_id from the example response. The id value should be used instead.

[ln-ws]

Thank you

[ssddanbrown]

Thanks again @ln-ws, this has been addressed as part of 1f25062 to be part of the next patch release.