update api refference - objects #305
Workflow file for this run
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
# name: Sync OpenAPI definition and Markdown docs to ReadMe | |
# # Run workflow for every push to the `master` branch | |
# on: | |
# push: | |
# branches: | |
# - master | |
# jobs: | |
# sync: | |
# runs-on: ubuntu-latest | |
# steps: | |
# - name: Checkout this repo | |
# uses: actions/checkout@v3 | |
# # Update API Reference Docs | |
# - name: Update API Reference Docs | |
# uses: readmeio/[email protected] | |
# with: | |
# rdme: openapi https://raw.githubusercontent.com/voucherifyio/voucherify-openapi/master/reference/OpenAPI.json --key=${{ secrets.README_API_KEY }} --id=${{ secrets.API_DEFINITION_ID }} | |
# # First we're going to perform a dry run of syncing process. | |
# # We do this on every push to ensure that an actual sync will work properly | |
# - name: Sync docs to ReadMe (dry run) | |
# uses: readmeio/[email protected] | |
# with: | |
# rdme: docs ./docs --key=${{ secrets.README_API_KEY }} --version=${{ secrets.README_MAIN_VERSION }} --dryRun | |
# # And finally, we perform an actual sync to ReadMe if we're on the main branch | |
# - name: Sync docs to ReadMe | |
# if: github.event_name == 'push' && github.event.ref == 'refs/heads/master' | |
# uses: readmeio/[email protected] | |
# with: | |
# rdme: docs ./docs --key=${{ secrets.README_API_KEY }} --version=${{ secrets.README_MAIN_VERSION }} |