878029fe48
* upgrade image version in devtools to 0.14.0 * fix idmldap configuration to use the cn attribute in order for that to also work for groups (groups don't have a uid attribute in the IDM built-in LDAP) * group resources are now checked against LDAP, changed demo-principals.yaml accordingly to refer to a group that exists in LDAP as part of the demo data
Groupware
The OpenCloud Groupware service provides a REST API for performing all the backend operations needed by the OpenCloud Groupware frontends.
OpenAPI Documentation
To generate the OpenAPI ("Swagger") documentation of the REST API, pnpm is a pre-requisite.
Run the following command in this directory to generate the swagger.yml OpenAPI definition file:
make apidoc
To generate a static HTML file using Redocly, which will generate a file api.html:
make apidoc-static
Path Parameters
Path parameters are documented in the file api-params.yaml and injected into the OpenAPI specification using the script apidoc-process.ts (which is done automatically when using the Makefile as described above.)
Favicon
A favicon is inserted into the static (Redocly) HTML file as part of the build process in the Makefile, using favicon.png as the source, computing its base64 to insert it as an image using a data URL in order to embed it.
That is performed by the script apidoc-postprocess-html.ts (which is done automatically when using then Makefile as described above.)