Skip to content

Update OpenAPI 3.1 Descriptions #8114

Update OpenAPI 3.1 Descriptions

Update OpenAPI 3.1 Descriptions #8114

Workflow file for this run

---
name: Lint OpenAPI Descriptions
permissions:
contents: read
on:
push:
pull_request:
workflow_dispatch:
jobs:
lint:
name: Lint OpenAPI ${{matrix.version}} releases
runs-on: ubuntu-latest
strategy:
matrix:
include:
- version: '3.0'
files: 'descriptions/**/*.yaml'
- version: '3.1'
files: 'descriptions-next/**/*.yaml'
steps:
- name: Checkout Code
uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0
- uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
name: Install Python
with:
python-version: '3.12'
- run: pip install --require-hashes -r requirements.txt
name: Install yamllint
- run: yamllint -f parsable -c .yamllint-config.yml ${{matrix.files}}
name: Run yamllint on ${{matrix.version}} descriptions
- name: Install NodeJS
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
with:
node-version: '16'
- name: Install Node modules
run: npm ci
# TODO: update script to pass in {{files}} so that this can support 3.1
- name: JSON Lint
run: npm run lint
- name: OpenAPI Lint
uses: mattpage/redocly-cli-lint-action@63f131fbfd009e0e32d01ccae6dbfbed3706ad88 # v0.0.1
with:
# TODO: use matrix.files variable when workflow is ready to process 3.1 files
entrypoints: 'descriptions/**/*.yaml'
config: '.redocly.yml'