Allow URLs as file source, including github API urls - #72
Draft
davidn wants to merge 1 commit into
Draft
Conversation
Motivation: gofoji#71 allows generating API clients from an openapi spec, however it may not be desirable to vendor the openapi spec. An example use-case is if you have microservices in different github repos, you may not want to copy the api spec into every callee service. Solution: foji.yaml can reference a URL instead of a local file. This also supportes "github files" which is a URL to the github API for fetching an individual file contents, to which foji will manage adding auth and accept headers. It is *STRONGLY* recommended to use a URL whose contents will not change, for example by embedding a tag into a github URL.
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #72 +/- ##
=======================================
Coverage ? 29.86%
=======================================
Files ? 45
Lines ? 2625
Branches ? 0
=======================================
Hits ? 784
Misses ? 1832
Partials ? 9 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation: #71 allows generating API clients from an openapi spec, however it may not be desirable to vendor the openapi spec. An example use-case is if you have microservices in different github repos, you may not want to copy the api spec into every callee service.
Solution: foji.yaml can reference a URL instead of a local file. This also supportes "github files" which is a URL to the github API for fetching an individual file contents, to which foji will manage adding auth and accept headers. It is STRONGLY recommended to use a URL whose contents will not change, for example by embedding a tag into a github URL.