Commit Graph

10 Commits

Author SHA1 Message Date
Pascal Bleser
db98532789 groupware: bump redocly/cli from 2.14.6 to 2.15.1 2026-07-01 14:57:30 +02:00
Pascal Bleser
c1fef77473 update redocly 2.14.5 -> 2.14.6 2026-07-01 14:57:30 +02:00
Pascal Bleser
27d4dda8d0 groupware: update pnpm 10.28.0 -> 10.28.1 2026-07-01 14:57:30 +02:00
Pascal Bleser
d7f5833d75 API documentation changes for groupware-apidocs
* add example generator infrastructure, with some examples for pkg/jmap
   and pkg/groupware, with more needing to be done

 * alter the apidoc Makefile to stop using go-swagger but, instead, use
   the openapi.yml file that must be dropped into that directory using
   groupware-apidocs (will improve the integration there later)

 * add Makefile target to generate examples

 * bump redocly from 2.4.0 to 2.14.5

 * introduce Request.PathParam() and .PathParamDoc() to improve API
   documentation, as well as future-proofing

 * improve X-Request-ID and Trace-Id header handling in the middleware
   by logging it safely when an error occurs in the middleware
2026-07-01 14:57:30 +02:00
Pascal Bleser
1b9c974b3d docs(groupware): upgrade @redocly/cli 2.3.1 -> 2.4.0 2026-07-01 14:57:28 +02:00
Pascal Bleser
988a70d201 groupware: update @redocly/cli from 2.3.0 to 2.3.1 2026-07-01 14:57:28 +02:00
Pascal Bleser
a9c2b38449 groupware: update @redocly/cli: 2.2.2 -> 2.3.0 2026-07-01 14:57:28 +02:00
Pascal Bleser
f133e4f8f6 groupware: add mock endpoints for addressbooks and contacts 2026-07-01 14:57:27 +02:00
Pascal Bleser
d2362b5782 start websocket implementation, add endpoint for email summaries
* feat(groupware): start implementing JMAP websocket support for push
   notifications (unfinished)

 * groupware: add GetLatestEmailsSummaryForAllAccounts

 * add new vendored dependency: github.com/gorilla/websocket

 * jmap: add QueryEmailSummaries

 * openapi: start adding examples

 * openapi: add new tooling for api-examples.yaml injection

 * apidoc-process.ts: make it more typescript-y

 * bump @redocly/cli from 2.0.8 to latest 2.2.0
2026-07-01 14:57:27 +02:00
Pascal Bleser
be79bd2892 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
2026-07-01 14:57:27 +02:00