Validate OpenAPI specification in CI

[ml-evs]

This PR adds an invoke task to get the response from https://validator.swagger.io/debug for a given URL. The CI then uses the commit SHA/repository to construct the URL for our OpenAPI schema, currently hard-coded to be at openapi/openapi.json and openapi/index_openapi.json, which it then pings the validator with.

[CasperWA]

Not many comments right now. As we're discussing on Slack as well, I'll just recap a bit:

• Possibly use POST instead to send the latest generated openapi.json as well as index_openapi.json content.
• Add the badge to the README (possibly).

In addition, I think we should remove openapi-spec-validator as a dependency and all uses of it.

[ml-evs]

In addition, I think we should remove openapi-spec-validator as a dependency and all uses of it.

Agreed, I've just replaced the openapi CI task with this.

[codecov]

Codecov Report

Merging #481 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #481   +/-   ##
=======================================
  Coverage   91.67%   91.67%           
=======================================
  Files          60       60           
  Lines        2848     2848           
=======================================
  Hits         2611     2611           
  Misses        237      237           

Flag	Coverage Δ
#unittests	91.67% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out 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 c70050e...90559d2. Read the comment docs.

[CasperWA]

In addition, I think we should remove openapi-spec-validator as a dependency and all uses of it.

Agreed, I've just replaced the openapi CI task with this.

openapi-spec-validator should also be removed from requirements-dev.txt.

[CasperWA]

This is looking great now. A final simplification from my side.

[ml-evs]

RE: readme badge, would you want it to just point to the master version of openapi/openapi.json? I'm not sure I'm that fussed...

[CasperWA]

RE: readme badge, would you want it to just point to the master version of openapi/openapi.json? I'm not sure I'm that fussed...

Yeah, that was my idea.
If you find it looks terrible, we'll just leave it out.

[ml-evs]

Yeah, that was my idea.
If you find it looks terrible, we'll just leave it out.

There's a shields.io version we can use:

Will add it later on once the other PRs are in.

[CasperWA]

Great with one less (direct) dependency, thanks @ml-evs !