[WIP] Swagger for the API

[Skarlso]

Started working on Swaggering up the API. Also updated to echo v4 for maximum module usage. ( and because the handler is using v4... grump grump )

[Skarlso]

Deals with #150.

[codecov-io]

Codecov Report

Merging #180 into master will decrease coverage by 1.26%.
The diff coverage is 55.62%.

@@            Coverage Diff             @@
##           master     #180      +/-   ##
==========================================
- Coverage   62.27%   61.01%   -1.27%     
==========================================
  Files          47       49       +2     
  Lines        3828     4266     +438     
==========================================
+ Hits         2384     2603     +219     
- Misses       1053     1220     +167     
- Partials      391      443      +52

Impacted Files	Coverage Δ
helper/pipelinehelper/pipelinehelper.go	100% <ø> (ø)	⬆️
store/pipeline.go	62.02% <0%> (-5.1%)	⬇️
handlers/user.go	39.68% <0%> (ø)	⬆️
handlers/pipeline_run.go	0% <0%> (ø)	⬆️
workers/scheduler/create_cmd.go	62.5% <0%> (-11.28%)	⬇️
handlers/hook.go	63.15% <100%> (ø)	⬆️
workers/pipeline/build_nodejs.go	100% <100%> (ø)
handlers/vault.go	57.37% <100%> (ø)	⬆️
security/vault.go	75% <100%> (-3.58%)	⬇️
handlers/workers.go	48.12% <100%> (ø)	⬆️
... and 33 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d09d3f2...0a75df4. Read the comment docs.

[Skarlso]

This is going to be a massive amount of frigging typing... :D :D :D

[Skarlso]

This also needs a docs Pr describing how to update the swagger doc.

For now, I'm following the annotation outlined here: https://github.com/swaggo/swag#declarative-comments-format

To generate the docs, stand in the root folder and run:

swag init -g ./cmd/gaia/main.go

[michelvocks]

Cool. Good job @Skarlso

Do you know what the outcome is when you generate the docs? Is it a static HTML website?
We are currently using netlify as a host for our docs + website and want to make sure that we can still use that. 😄

[Skarlso]

I think I can get Swagger to generate static HTML. At least I know there is an option for that. :D I have no idea how well that works. :)

Right now, as you can see, it's a go file actually. :)

[Skarlso]

BTW. So right now basically the app is hosting its own documentation. Basically if you have a running Gaia instance you can access the api by going to gaia.org/swagger. Bumm instant living docs. Also useful for development.

But I agree that a static generated doc on a hosted site would be also cool.

[michelvocks]

@Skarlso Yeah that's cool. But in the end, we need a hosted website where you can check the API from Gaia. 👍

[Skarlso]

Oh Gods. So much conflict on this now. :D

[Skarlso]

I'm going to close this one and re-open with the few changes. It's easier than trying to resolve all the conflicts.

[Skarlso]

Actually wasn't that hard. The go.mod and go.sum file might be off.

[Skarlso]

Alright. Going to continue doing this.

[Skarlso]

Hah, made it recognise the auth method.

curl -X GET "http://gaia-pipeline.io/api/v1/users" -H "accept: application/json" -H "Authorization: Bearer ASDFASDF="

Swagger generated get there.