Commit graph

23 commits

Author SHA1 Message Date
Martin W. Kirst
14177635b6
Update swagger API specification (#1782)
# 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>
2023-06-03 21:38:36 +02:00
6543
8b476e7722
Simplify web router code (#541) 2021-11-26 09:50:56 +01:00
6543
ff8ad5bb83
Fix registry delete (#532)
- Make make it possible to delete `"§4fda`
- Reject non urls for registry-address
- Fix #520
2021-11-25 19:04:36 +01:00
Anbraten
58838f225c
Rewrite of WebUI (#245)
Rewrite of the UI using Typescript, Vue3, Windicss and Vite. The design should  be close to the current one with some changes:
- latest pipeline in a sidebar on the right
- secrets and registry as part of the repo-settings (secrets and registry entries shouldn't be used as much so they can be "hidden" under settings IMO)
- start page shows list of active repositories with button to enable / add new ones (currently you see all repositories and in most cases you only add new repositories once in a while)
2021-11-03 17:40:31 +01:00
Anbraten
fd9448cad7
simplify routes (#437) 2021-10-13 18:36:11 +02:00
Anbraten
e6183e3378
Move api-routes to own file (#434) 2021-10-12 21:01:14 +02:00
Anbraten
f779860ff1
Add web-config.js endpoint (#433)
This is a preparation for #245 and adds a new endpoint (`.js``file) which can be included by the web-ui to get some config and credentials like the user profile or access-token.
2021-10-12 18:21:13 +02:00
John Olheiser
4276a04f0c
Move entirely to zerolog (#426)
Completely switch to zerolog

(Remove usage of logrus and std logger)

Signed-off-by: jolheiser <john.olheiser@gmail.com>
Co-authored-by: 6543 <6543@obermui.de>
2021-10-12 09:25:13 +02:00
6543
f81bd8c656
Extend Logging & Report to WebHook Caller back if pulls are disabled (#369)
* Add more logging 
* Format Code
* Add TODOs
* Fix nits
* Delete two unused functions
* Report to WebHook Caller back if pulls are disabled
2021-09-27 23:32:08 +02:00
Anbraten
bd19f90756
Replace www-path with www-proxy option for development (#248)
By adding a new ENV variable called `WOODPECKER_WWW_PROXY` it is possible to serve a webinterface via a proxy configured by the `WOODPECKER_WWW_PROXY` value for development instead of serving the interface from the bundled code or from some folder location as the old `WOODPECKER_WWW` option allowed. Using a proxy allows developing the UI with hot-reloading.
2021-09-27 00:22:23 +02:00
Jacob Floyd
b8f55f31e2
Move router package to server/router/ (#339) 2021-09-22 22:41:32 +02:00
Brad Rydzewski
d9fd23a6df experimental branch. playing around with boltdb 2015-04-07 01:20:55 -07:00
Ulrich Schreiner
aeb6895115 change the deactivate endpoint to HTTP-POST 2015-02-11 07:56:22 +01:00
Ulrich Schreiner
ae236a3d4d reworked to have two distinct REST handlers 2015-02-05 15:27:26 +01:00
Scott Ferguson
fa003af8cf Add feed route 2014-11-11 10:02:31 -06:00
Brad Rydzewski
0ec2a65067 added docs to README 2014-11-10 00:24:47 -08:00
Brad Rydzewski
2c75f225d9 Merge pull request #600 from netantho/netantho-584
Fixes #584
2014-11-06 23:55:32 -08:00
Christopher Brickley
e4e7773644 update to new goji wildcard format 2014-11-04 16:28:17 -05:00
Kirill Zaitsev
eef53530c1 Allow sync manually, instead force sync at ever login 2014-10-28 19:51:54 +03:00
Brad Rydzewski
601e3e6d48 slightly altered the URL token format 2014-10-22 00:41:25 -07:00
Anthony Verez
b444748b6c Fixes #584 2014-10-20 21:26:43 +02:00
Brad Rydzewski
cc71957c8d moving websockets to subrouter 2014-10-16 11:35:25 -07:00
Brad Rydzewski
7a7c5a9c0d added package for routes in an attempt to cleanup main.go 2014-10-09 20:26:51 -07:00