validate-descriptions.yml

name: OpenAPI Parser Validation for latest OpenAPI docs

on:
  push:
    branches: [ main, support/v1 ]
  pull_request:
    branches: [ main, support/v1 ]

jobs:

  list-descriptions:
    runs-on: ubuntu-latest
    outputs:
      matrix: ${{ steps.set-descriptions.outputs.matrix }}
    steps:
      - uses: actions/checkout@v4
      - id: set-descriptions
        run: echo "::set-output name=matrix::$(ls test/**/Resources/*.{json,yaml} | sed 's/.*\///' | jq -R -s -c 'split("\n")[:-1]')"

  build:
    needs: list-descriptions
    strategy:
      matrix:
        descriptions: ${{ fromJson(needs.list-descriptions.outputs.matrix) }}

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4
      with:
        submodules: recursive

    - name: Install Redocly CLI
      run: npm i -g @redocly/cli@latest

    - name: Validate description with redocly
      run: |
        FILE="test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/${{ matrix.descriptions }}"
        COMMON_ARGS="--skip-rule operation-4xx-response \
                     --skip-rule no-server-trailing-slash \
                     --skip-rule no-unused-components \
                     --skip-rule security-defined \
                     --skip-rule info-license-url \
                     --skip-rule info-license \
                     --skip-rule no-empty-servers \
                     --skip-rule operation-summary \
                     --skip-rule tag-description \
                     --max-problems 1000"

        if [ "${{ matrix.descriptions }}" = "TripService.OpenApi.json" ]; then
          redocly lint "$FILE" --generate-ignore-file $COMMON_ARGS
        else
          redocly lint "$FILE" $COMMON_ARGS
        fi