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.

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

Automatically update Swagger API documentation #279

Open
1 task
maxkadel opened this issue Aug 9, 2024 · 0 comments
Open
1 task

Automatically update Swagger API documentation #279

maxkadel opened this issue Aug 9, 2024 · 0 comments

Comments

@maxkadel
Copy link
Collaborator

maxkadel commented Aug 9, 2024

User story

  • As a developer who consumes the Allsearch API, I want to be sure that I am looking at the most up-to-date API documentation on swagger.
  • As a developer who works on the Allsearch API, I frequently forget to manually update the API documentation, and miss checking for updates in code reviews. I want an automated process to ensure this documentation has been updated when the code that impacts it changes.

Acceptance criteria

  • There is an automated process that either updates the swagger documentation, or that fails in CI if it is not up-to-date

Concrete example

  • If a developer adds a new endpoint to the api, they should be automatically alerted that the Swagger documentation is out of date, or it should be automatically generated

Implementation notes, if any

  • Possibly a git hook, like we use for linting on some projects?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants