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

Add script to persist OpenAPI file #10

Merged
merged 1 commit into from
Sep 21, 2023
Merged

Commits on Sep 21, 2023

  1. Add script to persist OpenAPI specification

    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 committed Sep 21, 2023
    Configuration menu
    Copy the full SHA
    8eec83d View commit details
    Browse the repository at this point in the history