mirror of
https://github.com/opencloud-eu/opencloud.git
synced 2026-06-17 20:38:49 -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
771 B
Go
44 lines
771 B
Go
// OpenCloud Groupware API
|
|
//
|
|
// Documentation for the OpenCloud Groupware API
|
|
//
|
|
// Schemes: https
|
|
// BasePath: /groupware
|
|
// Version: 1.0.0
|
|
// Host:
|
|
//
|
|
// Consumes:
|
|
// - application/json
|
|
//
|
|
// Produces:
|
|
// - application/json
|
|
//
|
|
// Security:
|
|
// - bearer
|
|
//
|
|
// swagger:meta
|
|
package groupware
|
|
|
|
// When the request contains invalid parameters.
|
|
// swagger:response ErrorResponse400
|
|
type SwaggerErrorResponse400 struct {
|
|
// in: body
|
|
Body struct {
|
|
*ErrorResponse
|
|
}
|
|
}
|
|
|
|
// When the requested object does not exist.
|
|
// swagger:response ErrorResponse404
|
|
type SwaggerErrorResponse404 struct {
|
|
}
|
|
|
|
// When the server was unable to complete the request.
|
|
// swagger:response ErrorResponse500
|
|
type SwaggerErrorResponse500 struct {
|
|
// in: body
|
|
Body struct {
|
|
*ErrorResponse
|
|
}
|
|
}
|