I would like to make the security module available with a RESTful API module. So I need to document the necessary calls to: create a new user; create and manage a role; assign permissions on the entities of a role; … I thought having the class diagram of the security module help me to better define the description of the RESTfull API.
Is there already a detailed description of the RESTfull API of the security module for the aforementioned features that I can use?
Any CUBA application with REST API add-on provides the documentation on all its REST endpoints in Swagger format, see Project-specific Swagger Documentation. You can just insert the URL of your application documentation endpoint in the address field here: Swagger UI and press Enter, and you will see the detailed description of the API: