mirror of
https://github.com/opencloud-eu/opencloud.git
synced 2026-06-17 12:28:57 -04:00
e377dfc2b9
* 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
44 lines
1.0 KiB
YAML
44 lines
1.0 KiB
YAML
servers:
|
|
- url: https://localhost:9200/
|
|
description: Local Development Server
|
|
tags:
|
|
- name: bootstrap
|
|
x-displayName: Bootstrapping
|
|
description: Initialization APIs
|
|
- name: account
|
|
x-displayName: Accounts
|
|
description: APIs for accounts
|
|
- name: identity
|
|
x-displayName: Identities
|
|
description: APIs for identities
|
|
- name: mailbox
|
|
x-displayName: Mailboxes
|
|
description: APIs that pertain to mailboxes
|
|
- name: message
|
|
x-displayName: Messages
|
|
description: APIs about emails
|
|
- name: vacation
|
|
x-displayName: Vacation Responses
|
|
description: APIs about vacation responses
|
|
x-tagGroups:
|
|
- name: Bootstrapping
|
|
tags:
|
|
- bootstrap
|
|
- name: Accounts
|
|
tags:
|
|
- account
|
|
- name: Emails
|
|
tags:
|
|
- identity
|
|
- mailbox
|
|
- message
|
|
- vacation
|
|
components:
|
|
securitySchemes:
|
|
api:
|
|
description: Authentication for API Calls
|
|
type: openIdConnect
|
|
openIdConnectUrl: https://keycloak.opencloud.test/realms/openCloud/.well-known/openid-configuration
|
|
security:
|
|
- api
|