You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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?
The text was updated successfully, but these errors were encountered:
User story
Acceptance criteria
Concrete example
Implementation notes, if any
The text was updated successfully, but these errors were encountered: