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 spec and push to swaggerhub #187

Closed
scottwn opened this issue Mar 11, 2022 · 3 comments
Closed

Automatically update swagger spec and push to swaggerhub #187

scottwn opened this issue Mar 11, 2022 · 3 comments
Assignees
Labels
cloud Issues related to cloud development devops CI/CR and repo maintenance documentation Improvements or additions to documentation priority / medium One of the priorities in a month

Comments

@scottwn
Copy link
Contributor

scottwn commented Mar 11, 2022

When a covalent service is run in dev mode, the openapi yaml for that service should be updated if the API is returning or accepting something different than the spec.

After an openapi yaml has changed, it should automatically update Swaggerhub.

Swaggerhub is and will remain the single source of truth for spec. Until this automation is built, devs are resposible for updating Swaggerhub manually. Changes to APIs should not be merged unless the spec is changed first.

@scottwn scottwn added devops CI/CR and repo maintenance documentation Improvements or additions to documentation priority / medium One of the priorities in a month labels Mar 11, 2022
@scottwn scottwn added the cloud Issues related to cloud development label May 9, 2022
@scottwn
Copy link
Contributor Author

scottwn commented Jun 1, 2022

Potentially leverage swaggerhub CLI

https://smartbear.wistia.com/medias/4y2j1nlmok

@scottwn
Copy link
Contributor Author

scottwn commented Jun 1, 2022

maybe use swaggerhub automock

the idea is probably to lock down definitions in github, and only make changes in swaggerhub. use github connection to push assets to github. somehow run tests against automock in swaggerhub for any change.

@scottwn
Copy link
Contributor Author

scottwn commented Jun 1, 2022

look at the example github action at 30:00 in the video

@kessler-frost kessler-frost closed this as not planned Won't fix, can't repro, duplicate, stale Sep 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cloud Issues related to cloud development devops CI/CR and repo maintenance documentation Improvements or additions to documentation priority / medium One of the priorities in a month
Projects
None yet
Development

No branches or pull requests

2 participants