Add script to persist OpenAPI file #10
Merged
Conversation
This file contains 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
Polo2
force-pushed
the
add-bash-script-to-persist-OpenAPI
branch
from
fb3cd89
to
5c9572e
Compare
Run this script: it reads locahost/docs.json, and upate docs/openapi.json if necessary. - provide variables url or output_file_path if you need to override - the script fetch json content of locahost/docs.json (the OpenAPI page), with pretty-print answer `jq` - then, this pretty JSON is saved inside docs/openapi.json 🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉 How to use it: Each time you push a branch, run `bash docs/persist.sh`, and docs/openapi.json will be persisted. Then, via GitHub action, each change on this spec is received and processed by Bump.sh -> Is this a breaking change? 🤔 Reponses order has been modified, 404 comes after 422 ?
Polo2
force-pushed
the
add-bash-script-to-persist-OpenAPI
branch
from
5c9572e
to
8eec83d
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Run this script:
it reads locahost/docs.json, and upate docs/openapi.json if necessary.
provide variables url or output_file_path if you need to override
the script fetch json content of locahost/docs.json (the OpenAPI page),
with pretty-print answer
jqthen, this pretty JSON is saved inside docs/openapi.json
🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉
How to use it:
Each time you push a branch, run
bash docs/persist.sh, and docs/openapi.jsonwill be persisted.
Then, via GitHub action, each change on this spec is received and processed
by Bump.sh -> Is this a breaking change?