mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2024-12-31 20:58:43 +00:00
14177635b6
# Summary This PR drops the outdated former swagger.yaml/json and introduced automatic API document generation from Go code. The generated code is also used to generate documentation/markdown for the community page, as well as enable the Woodpecker server to serve a Swagger Web UI for manual tinkering. I did opt-in for gin-swagger, a middleware for the Gin framework, to ease implementation and have a sophisticated output. This middleware only produces Swagger v2 specs. AFAIK the newer OpenApi 3x tooling is not yet that mature, so I guess that's fine for now. ## Implemenation notes - former swagger.json files removed - former // swagger godocs removed - introduced new dependency gin-swagger, which uses godoc annotations on top of Gin Handler functions. - reworked Makefile to automatically generate Go code for the server - introduce new dependency go-swagger, to generate Markdown for documentation purposes - add a Swagger Web UI, incl. capabilities for manual API exploration - consider relative root paths in the implementation - write documentation for all exposed API endpoints - incl. API docs in the community website (auto-generated) - provide developer documentation, for the Woodpecker authors - no other existing logic/code was intentionally changed --------- close #292 --------- Co-authored-by: qwerty287 <80460567+qwerty287@users.noreply.github.com> Co-authored-by: 6543 <6543@obermui.de>
51 lines
668 B
Text
51 lines
668 B
Text
### IDEs ###
|
|
.idea/
|
|
.vscode/*
|
|
!.vscode/settings.json
|
|
!.vscode/launch.json
|
|
!.vscode/extensions.json
|
|
|
|
### GO ###
|
|
# Binaries for programs and plugins
|
|
*.exe
|
|
*.exe~
|
|
*.dll
|
|
*.so
|
|
*.dylib
|
|
vendor/
|
|
__debug_bin
|
|
|
|
# Test binary, built with `go test -c`
|
|
*.test
|
|
|
|
# Output of the go coverage tool, specifically when used with LiteIDE
|
|
*.out
|
|
|
|
### Frontend ###
|
|
web/dist/**
|
|
!web/dist/.gitkeep
|
|
web/node_modules/
|
|
web/*.log
|
|
web/.env
|
|
|
|
### Docker ###
|
|
docker-compose.yml
|
|
|
|
### Other ##
|
|
# runetime or build relicts
|
|
*.sqlite
|
|
*.out
|
|
/.env
|
|
extras/
|
|
/build/
|
|
/dist/
|
|
|
|
docs/venv
|
|
|
|
# helm charts
|
|
.cr-index/
|
|
.cr-release-packages/
|
|
|
|
### Generated by CI ###
|
|
docs/docs/40-cli.md
|
|
docs/docs/20-usage/90-rest-api.md
|