CI/CD: Add GitHub Actions Workflow to validate Swagger documentation
Open
api
backlog
cleanup
documentation
- Dominant language
- Go
- Stars
- 2.9k
- Forks
- 369
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 149
Description
#2485 identified it's possible for the API implementation and Swagger documentation to accidentally become divergent.
> It looks like the swagger spec can be generated from the `build_swagger.py` script. We can make a workflow to run that and check the diff between the generated swagger and the one checked in.
_Originally posted by @another-rex in https://github.com/google/osv.dev/issues/2486#issuecomment-2295437140_
Contributor guide
Assessment
This issue has not been assessed yet.