Skip to content

feat(openapi): adding a command to resolve circular and recursive references #2718

feat(openapi): adding a command to resolve circular and recursive references

feat(openapi): adding a command to resolve circular and recursive references #2718

Workflow file for this run

name: CI
on:
push:
branches:
- main
- next
pull_request:
jobs:
build:
name: Test Suite
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
node-version:
# see the following:
# https://github.com/actions/setup-node?tab=readme-ov-file#supported-version-syntax
# https://github.com/nvm-sh/nvm/issues/1998#issuecomment-594958684
- lts/-1
- lts/*
- latest
steps:
- uses: actions/checkout@v4
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
cache: npm
- name: Build and run tests
run: npm cit
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install deps
run: npm ci
- name: Build dist
run: npm run build
- name: Run tests
run: npm run lint
action:
name: GitHub Action Dry Run
runs-on: ubuntu-latest
steps:
- name: Checkout GitHub Action
uses: actions/checkout@v4
with:
path: rdme-repo
- name: Checkout external repo containing OpenAPI file
uses: actions/checkout@v4
with:
path: oas-examples-repo
repository: readmeio/oas-examples
# Since this workflow file is in the `rdme` repository itself,
# we need to test the GitHub Action using the current commit.
# This step builds the `rdme` action code so we can do that.
#
# This step is not required for syncing your docs to ReadMe!
- name: Rebuild GitHub Action for testing purposes
run: npm ci && npm run build:gha
working-directory: rdme-repo
- name: Run `openapi:validate` command
uses: ./rdme-repo/
with:
rdme: openapi:validate oas-examples-repo/3.1/json/petstore.json
- name: Run `openapi:validate` with filename in quotes
uses: ./rdme-repo/
with:
rdme: openapi:validate "oas-examples-repo/3.1/json/petstore.json"
# Docs: https://rdme-test.readme.io
- name: Run `openapi` command
uses: ./rdme-repo/
with:
rdme: openapi oas-examples-repo/3.1/json/petstore.json --key=${{ secrets.RDME_TEST_PROJECT_API_KEY }} --id=${{ secrets.RDME_TEST_PROJECT_API_SETTING }}
- name: Run `openapi` command with weird arg syntax
uses: ./rdme-repo/
with:
rdme: openapi "oas-examples-repo/3.1/json/petstore.json" --key "${{ secrets.RDME_TEST_PROJECT_API_KEY }}" --id=${{ secrets.RDME_TEST_PROJECT_API_SETTING }}