Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
upload-cloud

GitHub Action

RapidAPI OpenAPI

v1

RapidAPI OpenAPI

upload-cloud

RapidAPI OpenAPI

Auto update RapidAPI OpenAPI documentation

Installation

Copy and paste the following snippet into your .yml file.

              

- name: RapidAPI OpenAPI

uses: vvatelot/rapidapi-openapi-github-action@v1

Learn more about this action in vvatelot/rapidapi-openapi-github-action

Choose a version

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/[email protected]
      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/"