Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

CI/CD: Add GitHub Actions Workflow to validate Swagger documentation #2487

Open
andrewpollock opened this issue Aug 18, 2024 · 0 comments
Open

CI/CD: Add GitHub Actions Workflow to validate Swagger documentation #2487

andrewpollock opened this issue Aug 18, 2024 · 0 comments
Labels
api API-related infrastructure backlog Important but currently unprioritized documentation Improvements or additions to documentation

Comments

@andrewpollock
Copy link
Contributor

#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 #2486 (comment)
@andrewpollock andrewpollock added backlog Important but currently unprioritized documentation Improvements or additions to documentation api API-related infrastructure labels Aug 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
api API-related infrastructure backlog Important but currently unprioritized documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@andrewpollock