api-check.yml

#
# This action checks that the OAS files inside the repository are valid according
#   to the Italian API guidelines.
#
#  TODO: check if spectral-action supports remote rulesets.
#  TODO: consider pinning the ruleset version.
on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

permissions:
  checks: write

jobs:
  spectral:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - run: curl https://italia.github.io/api-oas-checker/spectral-full.yml > .spectral.yml

      # Get additional module required by spectral-full
      - run: mkdir functions
      - run: curl https://raw.githubusercontent.com/italia/api-oas-checker/f6f4e6e360b2ce9816dcca29396571dda1c6027d/security/functions/checkSecurity.js > functions/checkSecurity.js

      - uses: stoplightio/spectral-action@v0.8.8
        with:
          file_glob: 'src/main/resources/public/api-docs.yaml'