search

aelve / guide

A workspace for research teams
https://guide.aelve.com
106 stars 10 forks source link

Generate swagger.json for branches #380

Closed neongreen closed 5 years ago

neongreen commented 5 years ago

Not tested yet.

neongreen commented 5 years ago

This PR makes it so that there's always an up-to-date swagger.json file in the repository. This will make it easier to see whether a PR changes anything in the API, and if so, what exactly.

swagger.json isn't the most pleasant thing to read, so in the future I also want to generate a Markdown file with the list of endpoints. (I tried servant-docs for it but it wasn't good enough.)

Once it's done, we might be able to get rid of the custom query functions in ApiSpec and replace them with servant-client. This is yet to be discussed, though.

neongreen commented 5 years ago

[skip ci] doesn't work because then Mergify is like "oh, but Travis hasn't passed, so I shouldn't merge this".

Okay, let's remove [skip ci] and suffer from increased build times.