docs(groupware): OpenAPI improvements

* refactor some pkg/jmap and groupware methods to make more sense from
   an API point-of-view

 * add path parameter documentation, but automate it by injecting their
   definition into the OpenAPI YAML tree that is extracted from the
   source code using go-swagger as it is too cumbersome, repetitive and
   error-prine to document them in the source code; wrote a TypeScript
   file apidoc-process.ts to do so

 * add generating an offline HTML file for the OpenAPI documentation
   using redocly, and injecting a favicon into the resulting HTML; wrote
   a TypeScript file apidoc-postprocess-html.ts to do so
This commit is contained in:
Pascal Bleser
2025-09-05 14:36:54 +02:00
parent e75216e898
commit be79bd2892
24 changed files with 2839 additions and 127 deletions

View File

@@ -31,5 +31,5 @@ const (
logDownloadUrl = "download-url"
logBlobId = "blob-id"
logUploadUrl = "download-url"
logSince = "since"
logSinceState = "since-state"
)