luisgulo/focalboard
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
ae29eb4c90
focalboard/server/swagger
History
Chen-I Lim 86dcb8c25b
Add warning to API readme (#2140)
2022-01-18 13:02:43 -08:00
..
docs/html Fixing and regenerating swagger documentation (#1990) 2021-12-15 20:54:23 +01:00
README.md Add warning to API readme (#2140) 2022-01-18 13:02:43 -08:00
swagger.yml Fixing and regenerating swagger documentation (#1990) 2021-12-15 20:54:23 +01:00

README.md

Swagger / OpenAPI 2.0 auto-generated files

⚠️ Warning: The API is currently considered Beta and major changes are planned. Please see this note for more details.

This folder is generated by the make swagger command from comments in the server code.

Prerequisites:

  1. go-swagger
  2. 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.