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 /usersCREATE 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.
Describe the Bug
In the BookStack API documentation for the
/users
endpoint, specifically for theCREATE
request, the body parameters documentation fails to specify the required type for thename
andpassword
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
/users
endpoint.CREATE
request.name
property lacks a type specification.password
property also lacks a type specification.Expected Behaviour
We expect the body parameters documentation for the
/users
CREATE
endpoint to clearly specify the data types for all properties. Specifically:name
property should be explicitly labeled with the typestring
.password
property should also be explicitly labeled with the typestring
.Screenshots or Additional Context
No response
Browser Details
No response
Exact BookStack Version
v24.05.3