Missing type specifications for name and password in /users CREATE endpoint documentation #4929

New Issue

OVERLORD · 2026-02-05T09:27:10+03:00

OVERLORD commented

2026-02-05 09:27:10 +03:00

Originally created by @ln-ws on GitHub (Aug 27, 2024).

Describe the Bug

In the BookStack API documentation for the /users endpoint, specifically for the CREATE request, the body parameters documentation fails to specify the required type for the name and password properties. This omission can lead to confusion for developers implementing API calls, potentially resulting in incorrect data types being sent and causing unexpected errors.

Steps to Reproduce

Navigate to the BookStack API documentation.
Scroll down to the section for the /users endpoint.
Find the documentation for the CREATE request.
Observe that the name property lacks a type specification.
Observe that the password property also lacks a type specification.
Compare these to other properties in the same documentation that do have type specifications.

Expected Behaviour

We expect the body parameters documentation for the /users CREATE endpoint to clearly specify the data types for all properties. Specifically:

The name property should be explicitly labeled with the type string.
The password property should also be explicitly labeled with the type string.
This type information should be consistently presented, matching the format used for other properties in the same documentation.

Screenshots or Additional Context

No response

Browser Details

No response

Exact BookStack Version

v24.05.3

Originally created by @ln-ws on GitHub (Aug 27, 2024). ### Describe the Bug In the BookStack API documentation for the `/users` endpoint, specifically for the `CREATE` request, the body parameters documentation fails to specify the required type for the `name` and `password` properties. This omission can lead to confusion for developers implementing API calls, potentially resulting in incorrect data types being sent and causing unexpected errors. ### Steps to Reproduce 1. Navigate to the BookStack API documentation. 2. Scroll down to the section for the `/users` endpoint. 3. Find the documentation for the `CREATE` request. 4. Observe that the `name` property lacks a type specification. 5. Observe that the `password` property also lacks a type specification. 6. Compare these to other properties in the same documentation that do have type specifications. ### Expected Behaviour We expect the body parameters documentation for the `/users` `CREATE` endpoint to clearly specify the data types for all properties. Specifically: - The `name` property should be explicitly labeled with the type `string`. - The `password` property should also be explicitly labeled with the type `string`. - This type information should be consistently presented, matching the format used for other properties in the same documentation. ### Screenshots or Additional Context _No response_ ### Browser Details _No response_ ### Exact BookStack Version v24.05.3

OVERLORD added the 🐛 Bug label 2026-02-05 09:27:10 +03:00

OVERLORD closed this issue

2026-02-05 09:27:11 +03:00

OVERLORD commented

2026-02-05 09:27:14 +03:00

@ssddanbrown commented on GitHub (Aug 27, 2024):

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

@ssddanbrown commented on GitHub (Aug 27, 2024): Thanks for raising @ln-ws, this has been addressed as part of 1f2506221ad7207b37bd093ca3233347d6d76ca1 to be part of the next patch release.

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/BookStack#4929

Missing type specifications for name and password in /users CREATE endpoint documentation #4929