Skip to content

Github Action to auto update Open API definition on RapidAPI platform

License

Notifications You must be signed in to change notification settings

vvatelot/rapidapi-openapi-github-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RapidAPI auto update OpenAPI documentation

This action updates the OpenAPI documentation of an API that is hosted by RapidAPI using their OpenAPI Provisioning API

Inputs

rapidapi-api-key

Optional Your RapidAPI API Key.

rapidapi_api_id

Optional Your RapidAPI API ID.

openapi_file

Optional The OpenAPI file you want to upload. Default "openapi.json".

default_server_url

Optional You can provide a default server url. Default "".

Example usage

name: Update OpenAPI RapidAPI documentation
on:
  schedule:
    # https://crontab.guru/every-night-at-midnight
    - cron: "0 0 * * *"

jobs:
  update-rapidapi-openapi:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: RapidAPI OpenAPI
      uses: vvatelot/rapidapi-openapi-github-action@v1.3.0
      with:
        rapidapi-api-key: ${{ secrets.RAPIDAPI_API_KEY }}
        rapidapi_api_id: ${{ secrets.RAPIDAPI_API_ID }}
        openapi_file: "my-openapi.json"
        default-url-server: "https://my.api.com:8001/"

About

Github Action to auto update Open API definition on RapidAPI platform

Resources

License

Stars

Watchers

Forks