20 lines
796 B
Markdown
20 lines
796 B
Markdown
# Swagger / OpenAPI 2.0 auto-generated files
|
|
|
|
⚠️ **Warning:** The API is currently considered Beta and major changes are planned. Please [see this note](https://github.com/mattermost/focalboard/discussions/2139) for more details.
|
|
|
|
This folder is generated by the `make swagger` command from comments in the server code.
|
|
|
|
Prerequisites:
|
|
1. [go-swagger](https://goswagger.io/install.html)
|
|
2. [openapi-generator](https://github.com/OpenAPITools/openapi-generator)
|
|
|
|
These can be installed via Homebrew:
|
|
```
|
|
brew tap go-swagger/go-swagger
|
|
brew install go-swagger
|
|
brew install openapi-generator
|
|
```
|
|
|
|
# Server API documentation
|
|
|
|
See the generated [server API documentation here](https://htmlpreview.github.io/?https://github.com/mattermost/focalboard/blob/main/server/swagger/docs/html/index.html).
|