mirror/opencloud
1
0
Fork 0
mirror of https://github.com/opencloud-eu/opencloud.git synced 2026-01-22 12:59:23 -05:00
Code Issues Packages Projects Releases Wiki Activity

groupware: also update DEVELOPER.md with new OpenAPI documentation generation tooling

Browse Source
This commit is contained in:
Pascal Bleser
2026-01-22 14:21:40 +01:00
parent 4778cd52e7
commit e6b59c8124
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
services/groupware/DEVELOPER.md
View File

@@ -611,10 +611,14 @@ If you run it from your IDE, there is obviously no need to do that.
## API Docs
The REST API documentation is extracted from the source code structure and documentation using [`go-swagger`](https://goswagger.io/go-swagger/), which needs to be installed locally as a prerequisite:
The REST API documentation is extracted from the source code structure and documentation the home-grown [`groupware-apidocs`](https://github.com/opencloud-eu/groupware-apidocs) tool, which needs to be installed locally as a prerequisite:
```bash
go install github.com/go-swagger/go-swagger/cmd/swagger@latest
cd "$OCDIR/"
git clone https://github.com/opencloud-eu/groupware-apidocs
cd ./groupware-apidocs/
go build .
ln -s "$PWD/groupware-apidocs" ~/.local/bin/
```
The build chain is integrated within the `Makefile` in `services/groupware/`: